From b8bbed16514fe41d0e42598fd0b611fb1cfa6ac3 Mon Sep 17 00:00:00 2001 From: Romain Derelle Date: Tue, 10 Sep 2024 09:27:05 +0100 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 80e31ea..3c4701e 100644 --- a/README.md +++ b/README.md @@ -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 ``` @@ -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 +

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).

+ +

Here are some examples of runtimes (in seconds) using real-world Mtb genomic data on a M2 Macbook Air:

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

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: