Skip to content

Commit

Permalink
added documentation on --list and fastq file size filter
Browse files Browse the repository at this point in the history
  • Loading branch information
MarieLataretu authored Jan 8, 2025
1 parent f735010 commit 6463b44
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,12 @@ MN908947.3 3144 3166 nCoV-2019_4_LEFT nCoV-2019_2 +
MN908947.3 4240 4262 nCoV-2019_4_RIGHT nCoV-2019_2 -
```

### Sample sheet
### Sample input

> [!NOTE]
> For fastq input without `--sample` and `--list`, samples with less then 1500 kB file size after fastq concatenation and size selection, are removed.
#### Sample sheet
* barcodes can be automatically renamed via `--samples sample_names.csv`
* required columns:
* `_id` = sample name
Expand All @@ -181,7 +186,17 @@ _id,Status,Description
Sample_2021,barcode01,good
2ndSample,BC02,bad
```


#### --list

* alternatively, fasta and fastq files can automatically renamed via `--fast[a|q] list.csv --list`
* no header required, example:

```csv
sample1,path_to_first_sample.fastq.gz
sample2,path_to_second_sample.fastq.gz
```

### Pangolin Lineage definitions
* lineage determinations are quickly changing in response to the pandemic
* to avoid using out of date lineage schemes, a `--update` flag can be added to each poreCov run to get the most recent version-controlled pangolin container
Expand Down
3 changes: 3 additions & 0 deletions poreCov.nf
Original file line number Diff line number Diff line change
Expand Up @@ -508,6 +508,9 @@ ${c_yellow}Workflow control (optional)${c_reset}
Status,_id
barcode01,sample2011XY
BC02,thirdsample_run
--list --fast[a|q] is a csv file containing a new sample name and the path (no header), e.g.:
sample1,path_to_first_sample.fastq.gz
sample2,path_to_second_sample.fastq.gz
--extended poreCov utilizes from --samples these additional headers:
Submitting_Lab,Isolation_Date,Seq_Reason,Sample_Type
--nanopolish use nanopolish instead of medaka for ARTIC (needs --fast5)
Expand Down

0 comments on commit 6463b44

Please sign in to comment.