From 346b55d36bdaf77a66dcd6234c48254f908a03b7 Mon Sep 17 00:00:00 2001
From: John Lafin <john.lafin@utsouthwestern.edu>
Date: Thu, 25 Jul 2024 08:47:15 -0500
Subject: [PATCH] Add example tables to docs
---
README.md | 9 +++++++++
docs/index.md | 9 +++++++++
2 files changed, 18 insertions(+)
diff --git a/README.md b/README.md
index 9501e57..cfa34ae 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 8c48c03..86081a4 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:
--
GitLab