Skip to content

Commit 67d277e

Browse files
committed
update docs
1 parent a4d9088 commit 67d277e

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

docs/workflow.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -103,26 +103,26 @@ Rscript --vanilla filter_and_BH.R <tag>
103103

104104
## File description
105105

106-
**`all_splicing_variants*.bed`** - a file containing all of the variants that regtools identified as being associated with a junction for the given parameters used to run `cis-splice-effects identify`.\
107-
**`dir_names.tsv`** - a file containing a list of each of the sample directories with each directory on a new line. This can be obtained by using `ls samples/ > dir_names.tsv`. For this example, it would look like:
106+
* **`all_splicing_variants*.bed`** - a file containing all of the variants that regtools identified as being associated with a junction for the given parameters used to run `cis-splice-effects identify`.
107+
* **`dir_names.tsv`** - a file containing a list of each of the sample directories with each directory on a new line. This can be obtained by using `ls samples/ > dir_names.tsv`. For this example, it would look like:
108108

109109
```bash
110110
Sample_1
111111
Sample_2
112112
```
113113

114-
**`variants_all_sorted.vcf.gz`** - a compressed vcf file containing all variants from all samples.\
115-
**`variants_all_sorted.vcf.gz.tbi`** - an index file for the vcf file mentioned above.\
116-
**`samples/`** - a directory containing each of the samples to be analyzed alongside each other.\
117-
**`Sample_1/`** - a sample directory. This will contain input data files as well as output files from RegTools.\
118-
**`tumor_rna_alignments.bam`** - file containing aligned RNA-seq reads for the given sample.\
119-
**`tumor_rna_alignments.bam.bai`** - index file for the above RNA-seq alignment file.\
120-
**`variants.vcf.gz`** - a compressed vcf file containing all variants from a given samples.\
121-
**`variants.vcf.gz.tbi`** - an index file for the vcf file mentioned above.\
122-
**`logs/`** - directory containing log or error files for a given sample.\
123-
**`output/`** - directory containing RegTools output files for a given sample.\
124-
**`cse_identify_filtered_*`** - RegTools output files from the initial RegTools run for a given sample. This will contain results for this sample's variants only.\
125-
**`cse_identify_filtered_compare_*`** - RegTools output files from the second RegTools run for a given sample. This will contain results for all samples' variants.\
126-
**`variants*.bed`** - a bedfile containing the variants considered to be splicing relevant for a given RegTools parameter. This is used later to make `all_splicing_variants*.bed`.\
127-
**`compare_junctions/hist/`** - directory containing output from the statistics script analyze all variants across all samples.\
128-
**`junction_pvalues_*.tsv`** - a file containing the output from the statistic analysis script.
114+
* **`variants_all_sorted.vcf.gz`** - a compressed vcf file containing all variants from all samples.
115+
* **`variants_all_sorted.vcf.gz.tbi`** - an index file for the vcf file mentioned above.
116+
* **`samples/`** - a directory containing each of the samples to be analyzed alongside each other.
117+
* **`Sample_1/`** - a sample directory. This will contain input data files as well as output files from RegTools.
118+
* **`tumor_rna_alignments.bam`** - file containing aligned RNA-seq reads for the given sample.
119+
* **`tumor_rna_alignments.bam.bai`** - index file for the above RNA-seq alignment file.
120+
* **`variants.vcf.gz`** - a compressed vcf file containing all variants from a given samples.
121+
* **`variants.vcf.gz.tbi`** - an index file for the vcf file mentioned above.
122+
* **`logs/`** - directory containing log or error files for a given sample.
123+
* **`output/`** - directory containing RegTools output files for a given sample.
124+
* **`cse_identify_filtered_*`** - RegTools output files from the initial RegTools run for a given sample. This will contain results for this sample's variants only.
125+
* **`cse_identify_filtered_compare_*`** - RegTools output files from the second RegTools run for a given sample. This will contain results for all samples' variants.
126+
* **`variants*.bed`** - a bedfile containing the variants considered to be splicing relevant for a given RegTools parameter. This is used later to make `all_splicing_variants*.bed`.
127+
* **`compare_junctions/hist/`** - directory containing output from the statistics script analyze all variants across all samples.
128+
* **`junction_pvalues_*.tsv`** - a file containing the output from the statistic analysis script.

0 commit comments

Comments
 (0)