Skip to content

Commit 5335657

Browse files
committed
Update usage.md
1 parent 1532c72 commit 5335657

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

docs/usage.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
## Samplesheet input
88

9-
You will need to create a samplesheet with information about the samples you would like to analyse before running the pipeline. Use this parameter to specify its location. It has to be a tab-separated file with 4 columns, and a header row as shown in the examples below.
9+
You will need to create a samplesheet with information about the samples you would like to analyse before running the pipeline. Use this parameter to specify its location. It has to be a tab-separated file with at least four columns, and a header row as shown in the examples below.
1010

1111
```bash
1212
--input '[path to samplesheet file]'
@@ -15,11 +15,16 @@ You will need to create a samplesheet with information about the samples you wou
1515
### Samplesheet columns
1616

1717
| Column | Description |
18-
| ------------------- | ----------------------------------------------------------------------------------------------------- |
18+
|---------------------|-------------------------------------------------------------------------------------------------------|
1919
| `ID` | An incrementing value which acts as a unique number for the given sample |
2020
| `Sample` | Custom sample name. This entry will be identical for multiple MS runs from the same sample. |
2121
| `Condition` | Additional information of the sample can be defined here. |
22-
| `ReplicateFileName` | Full path to the MS file. These files have the extentions .raw, .mzML, mzML.gz, .d, .d.tar.gz, .d.zip |
22+
| `ReplicateFileName` | Full path to the MS file. These files have the extensions .raw, .mzML, mzML.gz, .d, .d.tar.gz, .d.zip |
23+
| `Fasta` | Full path to the FASTA file. These files have the extensions .fasta, .fa, .fas, .fna, .faa, .ffn |
24+
25+
> [!WARNING]
26+
> The `Fasta` column is optional, but you can use it to provide sample-specific FASTA files. If you want to use the same FASTA file for all samples, provide it via the `--fasta` parameter. Please ensure you use one of these options.
27+
2328

2429
The pipeline will auto-detect whether a sample is either in mzML, raw or tdf file format using the information provided in the samplesheet.
2530

0 commit comments

Comments
 (0)