Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rderelle authored Sep 10, 2024
1 parent 8682e88 commit b8bbed1
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The default command line is:
```
fastlin -d /path/directory_fastq_files -b barcodes_file.txt
```
If your dataset does not contain any BAM-derived fastq file, then we would recommend to apply a maximum kmer coverage threshold to reduce runtimes:
If your dataset consists of FASTQ files that are not BAM-derived, then you can apply a maximum kmer coverage threshold to reduce runtimes:
```
fastlin -d /path/directory_fastq_files -b barcode_file.txt -x 80
```
Expand Down Expand Up @@ -65,6 +65,19 @@ ERRxxxxx    paired    118  &nb

The sample ERRxxxxx contains a single strain belonging to lineage 2. This typing is supported by 7 kmer barcodes, with a median number of occurences of 45. Since the abundance of the strain is far below the theoretical kmer coverage (equal here to 118), we can conclude that the sample is likely to contain high level of contaminations or sequencing errors.

### Multithreading
<p>By default, fastlin runs on 1 thread. The number of threads can be increased using the '-t' parameter, which will split the sample set among all threads (for a single sample, increasing the number of threads will have no impact on runtime).</p>

<p>Here are some examples of runtimes (in seconds) using real-world Mtb genomic data on a M2 Macbook Air:</p>
<div align="center">

| data | 1 thread | 4 threads |
|--------------------|-----------|-----------|
| 12 paired FASTQ | 66.9 | 19.3 |
| 190 genomes FASTA | 6.7 | 1.8 |

</div>

### Error handling
<p>When fastlin cannot read a fastq file (e.g., faulty record within the fastq file, corrupt gzip file), it stops scanning it, re-initialises all values to 0 and reports the error message in the last column of the output file. Here is an example of output with 3 different errors:</p>

Expand Down

0 comments on commit b8bbed1

Please sign in to comment.