Skip to content

Commit 108e245

Browse files
committed
Update input metadata description
1 parent 154d111 commit 108e245

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

config/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,14 @@ To run the pipeline, you will need an environment with `snakemake`
55

66
## Inputs and outputs
77

8-
The workflow execution parameters are set in two configuration files in YAML format:
8+
The workflow requires a set of FASTA files (one per target sample), a corresponding set of
9+
BAM files (also one per target sample), and a metadata table in CSV format with one row per
10+
sample. The metadata must include the following columns: unique sample identifier (default column `ID`,
11+
used to match sequencing files with metadata), the date the sample was collected (default `CollectionDate`),
12+
the location where the sample was collected (default `ResidenceCity`), and GISAID accession (default `GISAIDEPI`).
13+
The default column names but can be customized if needed via the workflow parameters.
14+
15+
These parameters are set in two configuration files in YAML format:
916
[config.yaml](/config/config.yaml) (for general workflow settings) and
1017
[targets.yaml](/config/targets.yaml) (for specific dataset-related settings).
1118
The latter must be modified by the user to point the `SAMPLES` and `METADATA`

0 commit comments

Comments
 (0)