https://github.com/fulcrumgenomics/fqgrep
Grep for FASTQ files
https://github.com/fulcrumgenomics/fqgrep
bioinformatics fastq genomics rust
Last synced: about 1 month ago
JSON representation
Grep for FASTQ files
- Host: GitHub
- URL: https://github.com/fulcrumgenomics/fqgrep
- Owner: fulcrumgenomics
- License: mit
- Created: 2021-10-12T19:09:41.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T17:20:34.000Z (6 months ago)
- Last Synced: 2025-08-18T14:54:41.887Z (about 2 months ago)
- Topics: bioinformatics, fastq, genomics, rust
- Language: Rust
- Homepage:
- Size: 229 KB
- Stars: 99
- Watchers: 12
- Forks: 4
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# fqgrep
Grep for FASTQ files.
Search a pair of fastq files for reads that match a given ref or alt sequence.
[Visit us at Fulcrum Genomics](https://www.fulcrumgenomics.com) to learn more about how we can power your Bioinformatics with fqgrep and beyond.
## Install
### From bioconda
```console
conda install -c bioconda fqgrep
```
### From Source
```console
git clone ... && cd fqgrep
cargo install --path .
```
## Usage
To match a single pattern in a single FASTQ:
```console
fqgrep 'GACGAGATTA' /data/test.fastq.gz
```
To match two patterns across two FASTQs treating them as paired end:
```console
fqgrep --paired --threads 10 --regexp 'GACGAGATTA' --regexp 'GACGTGATTA' /data/testR1.fastq.gz /data/testR2.fastq.gz
```
## Help
See the following for usage:
```console
OVERVIEW
The fqgrep utility searches any given input FASTQ files, selecting records whose bases match one or more patterns. By default, a pattern matches the bases in a FASTQ record if the regular expression (RE) in the pattern matches the bases. An empty expression matches every line. Each FASTQ record that matches at least one of the patterns is written to the standard output.
INPUT COMPRESSION
By default, the input files are assumed to be uncompressed with the following exceptions: (1) If the input files are real files and end with .gz or .bgz, they are assumed to be GZIP compressed, or (2) if they end with .fastq or .fq, they are assumed to be uncompressed, or (3) if the -Z/--decompress option is specified then any unrecongized inputs (including standard input) are assumed to be GZIP compressed.
THREADS
The --threads option controls the number of threads used to search the reads. Independently, for single end reads or interleaved paired end reads, a single thread will be used to read each input FASTQ. For paired end reads across pairs of FASTQs, two threads will be used to read the FASTQs for each end of a pair. Finally, a single thread will be created for the writer.
EXIT STATUS
The fqgrep utility exits with one of the following values: 0 if one or more lines were selected, 1 if no lines were selected, and >1 if an error occurred.
Usage: fqgrep [OPTIONS] [ARGS]...
Arguments:
[ARGS]...
The first argument is the pattern to match, with the remaining arguments containing the files to match. If -e is given, then all the arguments are files to match. Use standard input if either no files are given or - is given
Options:
-t, --threads
The number of threads to use for matching reads against pattern. See the full usage for threads specific to reading and writing
[default: 10]
--color
Mark up the matching text. The possible values of when are “never”, “always” and “auto”
[default: never]
[possible values: never, always, auto]
-c, --count
Only a count of selected lines is written to standard output
-e, --regexp
Specify a pattern used during the search of the input: an input line is selected if it matches any of the specified patterns. This option is most useful when multiple -e options are used to specify multiple patterns
-F, --fixed-strings
Interpret pattern as a set of fixed strings
-f, --file
Read one or more newline separated patterns from file. Empty pattern lines match every input line. Newlines are not considered part of a pattern. If file is empty, nothing is matched
-v
Selected lines are those not matching any of the specified patterns
-Z, --decompress
Assume all unrecognized inputs are GZIP compressed
--paired
Treat the input files as paired. The number of input files must be a multiple of two, with the first file being R1, second R2, third R1, fourth R2, and so on. If the pattern matches either R1 or R2, then both R1 and R2 will be output (interleaved). If the input is standard input, then treat the input as interlaved paired end reads
--reverse-complement
Search the reverse complement for matches
--progress
Write progress information
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
```