Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme example data dir #12

Open
cbird808 opened this issue May 29, 2019 · 0 comments
Open

readme example data dir #12

cbird808 opened this issue May 29, 2019 · 0 comments

Comments

@cbird808
Copy link
Contributor

In the readme, there is an inconsistency in the nomenclature suggested for naming the files and directories. In the below "Examples" the does not occur in either the dir name or the file name. does the name of the project dir have to match the prefix on the files? if so, examples need to be updated

You need four pieces of input data:

  • _forward.fastq: Forward reads.
    • Example: testrun/TestData_forward.fastq
  • _reverse.fastq: Reverse reads.
    • Example: testrun/TestData_reverse.fastq
  • .barcodes.txt: Barcodes that label sequence sample.
    • Example: testrun/TestData.barcodes.txt
  • .sampledescs.csv: Arbitrary description of each sample.
    • Example: testrun/TestData.sampledescs.csv
    • Note: barcodes cannot have 'I' basepair code. I replace with 'N'.

Your directory should like this:

    <projname>/ 
    ├── out
    ├── in
    │   ├── <projname>.barcodes.txt
    │   ├── <projname>_forward.fasta
    │   ├── <projname>_reverse.fastq
    └── └── <projname>.sampledescs.csv
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant