Skip to content

Commit 73ed27f

Browse files
committed
Create TOC.md
1 parent 47c97b1 commit 73ed27f

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

inst/templates/base/TOC.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
The reports in this folder perform [analysis] of [data type(s) e.g. RNAseq] data from [project].
2+
3+
Overall goal: [copy from information.R > "experiment"]
4+
5+
Dataset:
6+
[Describe the data. If there are multiple datasets and multiple timepoints it may be helpful to have a table like so:
7+
| Timepoint | 0 | 1 | 2 | 3 | 4 | 5 | 6
8+
|-----------|---|---|---|---|---|---|----
9+
| ChIPseq | + | - | + | - | + | + | +
10+
| CUT&RUN | + | - | + | - | + | + | +
11+
| ATACseq | - | - | + | + | - | + | -
12+
| RNAseq | + | + | + | + | + | + | +
13+
]
14+
15+
Reports:
16+
17+
1. **Report name**: Short description (can be taken from information.R > "aim")
18+
- Analysis step 1 (can be taken from main headers in each report)
19+
- Analysis step 2
20+
- Analysis step 3
21+
2. **Report name**: Short description.
22+
- Analysis step 1
23+
- Analysis step 2
24+
- Analysis step 3
25+
3. **Report name**: Short description.
26+
- Analysis step 1
27+
- Analysis step 2
28+
- Analysis step 3
29+
30+
**The following reports are integral to the workflow** (while the other reports are more side investigations):
31+
32+
- #1: Short description.
33+
- #3: Short description.
34+
35+
**FINAL RESULTS ARE PRODUCED IN #3 [Description]:**
36+
37+
- Results can be found in reports/results/file.txt.

0 commit comments

Comments
 (0)