Skip to content

Commit

Permalink
Fixed typo in README
Browse files Browse the repository at this point in the history
  • Loading branch information
reillyowencooper committed Aug 22, 2024
1 parent 372a65c commit 92e2716
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ GCF_026212275.2_iyMicDemo2.1a,https://ftp.ncbi.nlm.nih.gov/genomes/all/GCF/026/2

The three columns `genome_accession`, `genome_ftp_path`, and `SRA_run_accession` are all required. The `genome_accession` must match the full accession name that is at the end of the FTP download path for a given assembly input. The FTP path is the full NCBI FTP download path for the entire accession, but not including the specific file to be downloaded, (such as not including GCF_026212275.2_iyMicDemo2.1a_genomic.fna.gz in the download link field) as this is done within the workflow code. The `SRA_run_accession` is just the accession and not the FTP download link.

For every pair of mapping results that you want, you must list them with each `genome_accession` and `SRA_run_accession` pairing. For example the above gives two rows of the same `M. lipitor` genome accession but different SRA run accessions. The workflow will sense duplicate genome accessions in the first column and only download it one time, but the different genome:SRA accession pairing need to be listed like the above to ensure proper mapping pairings. Therefore if you have multiple SRA run accessions to map against the same genome, you can copy columns 1 and 2 but change the SRA run accession in the third column in your samplesheet.
For every pair of mapping results that you want, you must list them with each `genome_accession` and `SRA_run_accession` pairing. For example the above gives two rows of the same `M. demolitor` genome accession but different SRA run accessions. The workflow will sense duplicate genome accessions in the first column and only download it one time, but the different genome:SRA accession pairing need to be listed like the above to ensure proper mapping pairings. Therefore if you have multiple SRA run accessions to map against the same genome, you can copy columns 1 and 2 but change the SRA run accession in the third column in your samplesheet.

Now you are ready to launch the workflow:
```
Expand Down

0 comments on commit 92e2716

Please sign in to comment.