Skip to content

Commit 8f3c151

Browse files
authored
Merge pull request #148 from evanfloden/patch-1
Update README.md with instructions for test data
2 parents 435812b + 8e29eff commit 8f3c151

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,20 +45,28 @@ Additional functionality contained by the pipeline currently includes:
4545
## Quick Start
4646

4747
1. Install [`nextflow`](docs/installation.md)
48+
4849
2. Install one of [`docker`](https://docs.docker.com/engine/installation/), [`singularity`](https://www.sylabs.io/guides/3.0/user-guide/) or [`conda`](https://conda.io/miniconda.html)
50+
4951
3. Download the EAGER pipeline
5052

5153
```bash
5254
nextflow pull nf-core/eager
5355
```
5456

55-
4. Set up your job with default parameters
57+
4. Test the pipeline using the provided test data
58+
59+
```bash
60+
nextflow run nf-core/eager -profile <docker/singularity/conda>,test --pairedEnd
61+
```
62+
63+
5. Start running your own ancient DNA analysis!
5664

5765
```bash
58-
nextflow run nf-core -profile <docker/singularity/conda> --reads'*_R{1,2}.fastq.gz' --fasta '<REFERENCE>.fasta'
66+
nextflow run nf-core/eager -profile <docker/singularity/conda> --reads'*_R{1,2}.fastq.gz' --fasta '<REFERENCE>.fasta'
5967
```
6068

61-
5. See the overview of the run with under `<OUTPUT_DIR>/MultiQC/multiqc_report.html`
69+
NB. You can see an overview of the run in the MultiQC report located at `<OUTPUT_DIR>/MultiQC/multiqc_report.html`
6270

6371
Modifications to the default pipeline are easily made using various options
6472
as described in the documentation.

0 commit comments

Comments
 (0)