Skip to content

Commit cb391e3

Browse files
committed
update docs
1 parent 2e3a291 commit cb391e3

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

docs/workflow.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,19 +83,31 @@ for i in samples/*/; do bsub -oo $i/logs/regtools_compare_$tag.lsf regtools cis-
8383

8484
## Statistical analysis
8585

86-
**Make directory to store comparison results**
86+
### Make directory to store comparison results
8787

8888
```bash
8989
mkdir -p compare_junctions/hist
9090
```
9191

92-
**Run `stats_wrapper.py` on sample data**
92+
### Run `compare_junctions_hist.py` on sample data
93+
94+
This script compares RegTools associations across all samples in a defined cohort to determine significance. By default, this script divides the input data into chunks of 50,000 variants in order to not max out memory for large cohorts. We provide three options for how to group case vs control groups with respect to a particular event (i.e. which samples do you consider to have the variant of interest vs. those that do not). The options are as follows:
95+
96+
1) only samples with exactly the same variant will be included in the case group, all others samples (even potentially those with very similar variants) will be included with the control group (`--variant-grouping=strict`)
97+
2) similar variants will be excluded from both the case and control groups (`--variant-grouping=exclude`)
98+
3) similar variants will be included in the case group (`--variant-grouping=include`)
99+
100+
*NOTE: "similar" is defined as associated with the same junction*
101+
102+
We recommend using `--variant-grouping=exclude` since determining whether nearby variants have a similar effect in terms of splicing consequence is often difficult.
93103

94104
```bash
95-
python3 stats_wrapper.py <tag>
105+
python3 compare_junctions_hist.py --tag <tag> --variant-grouping <parameter>
96106
```
97107

98-
**Run `filter_and_BH.R` to adjust p values and filter results**
108+
### Run `filter_and_BH.R` to adjust p values and filter results
109+
110+
This script filters significant results on junction support and junction type and then performs the Benjamini-Hochberg Procedure to apply multiple test correction to the data.
99111

100112
```bash
101113
Rscript --vanilla filter_and_BH.R <tag>

0 commit comments

Comments
 (0)