Skip to main content

A Python3 program that counts sequence occurences in fastq files.

Project description

Welcome to 2FAST2Q

A Python3 based program that counts sequence occurrences in FASTQ files 2FAST2Q is ideal for CRISPRi-Seq, and for extracting and counting any kind of information from Illumina reads, such as barcodes. 2FAST2Q can work with sequence mismatches, and can be used to find sequences delimited by known sequences in unaligned reads.

2FAST2Q can work with any classic CRISPRi experimental setup, or be used for any kind of sequence extraction from FASTQ files.

Check out my GitHub for the source files: https://github.com/afombravo/2FAST2Q

2FAST2Q is published as part of a CRISPRi-seq protocol: https://www.nature.com/articles/s41596-021-00639-6

A more in depth description of the program is also available as a preprint: https://www.biorxiv.org/content/10.1101/2021.12.17.473121v1

How to use it

There are two versions of the program, with and without a basic user interface.

After installation, type the following to initialize the program using the graphical interface:

python -m fast2q

For the non-graphical interface (the graphical interface can be buggy, or not work in some OS), type:

python -m fast2q -c

Make sure you have the latest version, type:

python -m fast2q -v

When running without specified parameters, 2FAST2Q will assume the current running directory has all the required files:

one .csv corresponding to features file (not required in 'Extract and Counter' mode)
the .FASTQ files

There are also several optional parameters. For their description and input type. A more in-depth description is provided below:

`python -m fast2q -h`

 `-h, --help  show this help message and exit `

 `-c [C]      cmd line mode`

 `-v [V]      prints the current version`

 `--s S       The full path to the directory with the sequencing files OR file`

 `--g G       The full path to the .csv file with the features.`

 `--o O       The full path to the output directory`

 `--fn FN     Specify an output compiled file name (default is called compiled)`

 `--v V       Adds progress bars (default is enabled)`

 `--m M       number of allowed mismatches (default=1)`

 `--ph PH     Minimal Phred-score (default=30)`

 `--st ST     Feature start position in the read (default is 0==1st bp)`

 `--l L       Feature length`

 `--us US     Upstream search sequence `

 `--ds DS     Downstream search sequence `

 `--msu MSU   mismatches allowed in the upstream sequence`

 `--msd MSD   mismatches allowed in the downstream sequence`

 `--qsu QSU   Minimal Phred-score (default=30) in the upstream search sequence`

 `--qsd QSD   Minimal Phred-score (default=30) in the downstream search sequence`

 `--mo MO     Running Mode (default=C) [Counter (C) / Extractor + Counter (EC)] `

 `--cp CP     Number of cpus to be used (default is max(cpu)-2 for >=3 cpus, -1 for >=2 cpus, 1 if 1 cpu `

 ` --k K       If enabled, keeps all temporary files (default is disabled) `

Inputs

To run the program, three input paths are required:

1. directory containing the sequencing files

(assumed to be the current directory when using the cmd line version and no inputs are given)

A path to the folder with the sequencing files (it doesn´t matter if in .gz or .fastq.gz format as 2fast2q auto determines the correct one)

2. the path to the feature .csv file (optional)

(assumed to be the only .csv file in the current directory when using the cmd line version and no inputs are given)

Only needed when searching the fastq file for known sequences, such as with a CRISPRi-Seq experiment. A path to the .csv file (this format can be obtained using the "save as" option in excel) with the nucleotide sequences of all used features, and their respective names (any name can be given, as long as it doesn’t repeat). See the provided "D39V_guides.csv" sample file. (Optional, only required when running in Counting mode)

sgRNA0001 AATAGCATAGAAATCATACA
sgRNA0002 AGTGTTGATTTACCAACGTT

Leave empty if you want to run the program in 'extract and count' mode (extract all found features without alignements)

3. the output directory

A path to the output folder (for safety, a subfolder will always be created on this directory) (2fast2q automatically creates a subdirectory within the current directory when using the cmd line version and no inputs are given)

4. Parameters

For extracting all sequences at a certain position in the read select the extractor + Counter (EC) mode. The default is Counter (C) mode only.

Progress Bar. (Default is enabled)

The minimal sequencing phred-score for each nucleotide (default = 30)

The start position of the feature within the read (default = 0, meaning the sequenced feature is located at the first position of the read sequence)

The lenght of the feature in bp (default = 20)

The number of allowed mismatches per feature (default = 1). 2FAST2Q mismatch feature calculates HAMMING distance ONLY

Keep temporary files mode (default = no). When enabled, deletes all temporary files. To keep all files, change to "n" in the graphical mode, or input the parameter --k in the cmd lines.

If the starting position varies within the read, it is possible to search for a delimiting known sequence, and then extract the sequence before/after it. In this case, it is allowed to input the following:

A 5' end search sequence, and the amount of bp the program should inventory after. A 3' end search sequence, and the amount of bp the program should inventory after. A 5'and 3' end search sequence, the program will return and count everything in between these two. How many mismatches are allowed in the search sequence.

While Running

=================================

2FAST2Q is coded to maximize any computer's processing power (it runs multiprocessed, so it can process various samples simultaneously). It is therefore advisable to not heavily use the computer while 2FAST2Q is running to avoid constraining the processor.

When running 2FAST2Q in the compiled form, the initialization sequence might take up to a minute. 2FAST2Q will be operational when "Version X.X.X" appears on the window. Depending on the used computer, 2FAST2Q might take a few minutes to run. If no errors are shown, 2FAST2Q is still running. GIVE IT TIME!

\\\\

macOS use WARNING!

When using the graphical user interface option, it's possible that the interface is buggy on some MacOS versions. In this case, it might be better to run the command line version via pip install fast2q

A completion message should be given at the end. In any case, the program will be finish when the compiled.csv file is visible in the directory.

Output

Upon completion, several files should be seen in the indicated output folder (when running in default mode only b, c, and d will be kept):

a. “*_reads.csv” files corresponding to the read counts per feature per inputted sequencing file;

b. A “compiled_stats.csv” containing all the relevant input/output information about the 2FAST2Q analysis;

c. A “compiled.csv” file with the compilation of all the read counts per feature in all the inputted files. Use this latter in the next steps of the data analysis pipeline.

d. A bar plot "reads_plot.png" with the number of total and quality passed reads (absolute), and in percentage ("reads_plot_percentage.png"), per sample;

e. 2 other violin plots with the distribution of the found features per sample are also presented (normalized for reads per milion, and absolute numbers). The interquartile distribution is also ploted for each sample (25%-75%)

Short Explanation

2FAST2Q will return the read counts for all the features present in the input file. A read will be aligned to its features if the minimum quality score in each nucleotide is >= the indicated phred-score, and if there is less than the indicated allowed mismatches. Like said before, these parameters can be modified by the user.

However, why these parameters?

Base quality filtering using Q>=30 means there is a 0.01% chance of a given nucleotide being miss-sequenced. To assure alignment quality, the program filters out by default any reads that have nucleotides with a Q < 30.

Why the mismatch?

To avoid a too highly stringent cutoff. Allowing a mismatch allows the alignment of reads to their features when just a single nucleotide is wrongly sequenced. Even at a 0.01% chance (Q>=30 default) this event is bound to happen due to the large sample size.

However, there is a safe mechanism in place to prevent 2 or more features with mismatches from being aligned to the same read (the read is discarded in this case, as there is no way of knowing to which feature the read aligns to)

2FAST2Q mismatch feature calculates HAMMING distance ONLY

Troubleshooting

Running 2FAST2Q with example data (see GitHub):

  1. Download the "D39V_guides.csv" file
  2. Download the "example.fastq.gz"
  3. Run 2FAST2Q

In this example, sgRNA0850 and sgRNA867 share the same sequence; this will appear as a warning message.

The expected example output file is given: "compiled.csv"

Common Errors:

Error Message Probable Cause/Fix
Please enter a valid directory for the following request: (see printed requests). Please close the program and start again You have entered an invalid file or folder location. Check that the correct folder/file was selected. When choosing a file click on the file. When selecting a folder, double click (go into the folder, no files will be visible. Its normal).
Please confirm that all the input boxes are filled. Some parameters are missing. Press any key to exit Click OK on the pop up parameter box. The wrong parameter format was entered. Please restart the program and re-introduce ALL the required paths (you must use the browse buttons for this), and parameters (or leave at default). Please close the program and start again
Only numeric values are accepted in the following fields: ... Introduce parameters that respect the default format (text and integers, when appropriate).
Warning!! X and Y share the same sequence. Only X will be considered valid. X and Y correspond to feature names. The indicated entries have the same sequence, and only the first will be considered valid.
Check the path to the feature file. No file found in the following path: X Confirm the indicated path (X) to the feature .csv file is correct
Check the path to the X files folder. No files of this type found. Confirm the indicated path to the folder with the sequencing (X) files is correct.
Program doesn’t initialize Confirm the downloaded program is the appropriate one for the current operating system. Contact the 2FAST2Q developer if the issue persists.
Program crashes, or behaves unexpectedly. Restart the program and carefully indicate the appropriate required input paths. Check if the program behaves as expected with the provided sample data. Contact the 2FAST2Q developer if the issue persists.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fast2q-2.5.2.tar.gz (22.4 kB view hashes)

Uploaded source

Built Distribution

fast2q-2.5.2-py3-none-any.whl (31.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page