diff --git a/README.md b/README.md index 9501e57aa4d5d6a9b5939b69528c5dbbd74d4735..cfa34aee97bb5885e7ac0236ea40726c1e4184d7 100755 --- a/README.md +++ b/README.md @@ -38,6 +38,15 @@ selected, only those matching the sample name will be included. - **introns**: true/false. Whether to count intronic reads. - **noBam**: true/false. Whether to skip bam file generation. This will save some time and space, but bam files may be required for downstream analysis and/or deposition into public databases. + +Here's an example sample sheet: + +| sample | reference | expectCells | chemistry | introns | noBam | +|-------------------|-----------|-------------|-----------|---------|-------| +| Brain_Tumor_3p_LT | hg38 | 0 | auto | true | true | +| hgmm_100 | mm10 | 0 | auto | true | true | +| hgmm_100 | barnyard | 0 | auto | true | true | +| hgmm_100 | barnyard | 100 | auto | true | false | ## Questions diff --git a/docs/index.md b/docs/index.md index 8c48c03568d606a471bcd8f3556b42fe03cb9709..86081a485da59bf2136216004c740724adf2568a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -33,6 +33,15 @@ selected, only those with prefixes matching the sample name will be included. - **noBam**: true/false. Whether to skip bam file generation. This will save some time and space, but bam files may be required for downstream analysis and/or deposition into public databases. +Here's an example sample sheet: + +| sample | reference | expectCells | chemistry | introns | noBam | +|-------------------|-----------|-------------|-----------|---------|-------| +| Brain_Tumor_3p_LT | hg38 | 0 | auto | true | true | +| hgmm_100 | mm10 | 0 | auto | true | true | +| hgmm_100 | barnyard | 0 | auto | true | true | +| hgmm_100 | barnyard | 100 | auto | true | false | + ## Output This workflow will provide the following output: