You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 4146e7e
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+11-8Lines changed: 11 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ conda activate SCOTCH
30
30
31
31
### Input and Output
32
32
33
-
In general, SCOTCH accepts BAM file(s) tagged by vendor-supplied pipelines for its preprocessing pipeline (For ONT data, please see [here](https://github.com/epi2me-labs/wf-single-cell) for more details), and output a series of information including read-isoform mappings, gene count matrix, isoform count matrix, and updated gene annotations. The `--bam` argument is used to assign input file(s), and `--target` is used to assign the output folder(s).
33
+
In general, SCOTCH accepts BAM file(s) tagged by vendor-supplied pipelines for its preprocessing pipeline (For ONT data, please see [here](https://github.com/epi2me-labs/wf-single-cell) for more details), and output a series of information including read-isoform mappings, gene count matrix, isoform count matrix, and updated gene annotations. The `--bam` argument is used to assign input file(s), and `--target` is used to assign the output folder(s). SCOTCH also supports bulk RNA-seq data, set `--bulk` argument if the input bam file is not single cell data.
34
34
35
35
The SCOTCH pipeline allows users to process one sample at a time or multiple samples simultaneously depending on study designs. When preprocessing multiple samples together, SCOTCH generates a unified gene/isoform annotation based on all BAM files. This approach is particularly beneficial in studies involving multiple samples, as it ensures consistent identification and consolidation of novel isoforms across different samples. Some usage examples are below:
36
36
@@ -78,14 +78,17 @@ SCOTCH offers three modes for generating gene annotations:
78
78
79
79
#### arguments
80
80
-`--bam`: path(s) to the bam file(s)/folder(s)
81
-
-`--workers`: number of threads for parallel computing.
81
+
-`--workers`: number of threads for parallel computing.
82
+
-`--coverage_threshold_gene`: coverage threshold to support gene discovery, default is 20.
83
+
-`--min_gene_size`: inimal length of novel discovered gene, default is 50.
82
84
-`--coverage_threshold_exon`: coverage threshold to support exon discovery, percentage to the maximum coverage, larger values will be more conservative, default is 0.02.
83
85
-`--coverage_threshold_splicing`: threshold to support splicing discovery, percentage to the maximum splicing junctions, larger values will be more conservative, default is 0.02.
84
86
-`--z_score_threshold`: z score threshold to discovery sharp changes of read coverage, larger values will be more conservative, default is 10.
85
87
-`--reference`: Path to gene annotation file in gtf format.
86
88
-`--reference_pkl`: Path to gene annotation file generated by SCOTCH named with geneStructureInformation.pkl file
87
89
-`--platform`: 10x-ont or 10x-pacbio or parse-ont
88
90
-`--barcode_cell` and `--barcode_umi`: if using 10x-ont platform, default setting is `--barcode_cell CB --barcode_umi UB`; if using 10x-pacbio platform, default setting is `--barcode_cell XC --barcode_umi XM`. Users can change this setting according to tags in bam files generated by different preprocessing workflows.
91
+
-`--save_mem_ann`: whether to use save memory mode to process in chunks, default is False
89
92
90
93
Below is an example of generating annotation in the Enhanced-Annotation Mode for two samples simultanuously. See `example/annotation.sh` for an implementation in slurm.
91
94
@@ -108,8 +111,9 @@ In this step, SCOTCH aligns reads to existing gene isoforms and identifies novel
108
111
-`--target`: the same with step1
109
112
-`--bam` the same with step1
110
113
-`--reference`: the same with step1
114
+
-`--reference_genome_fasta`: path to genome fasta file to reduce false positive novel isoform construction introduced by polyA stretch
111
115
-`--match_low` exon percentage lower threshold to call a read-exon unmapping. For example, setting 0.1 means reads covers <10% of the exon length as unmapped. (default is 0.1)
112
-
-`--match_low` exon percentage upper threshold to call a read-exon mapping. For example, setting 0.6 means reads covers <20% of the exon length as mapped. (default is 0.6)
116
+
-`--match_high` exon percentage upper threshold to call a read-exon mapping. For example, setting 0.6 means reads covers >60% of the exon length as mapped. (default is 0.6)
113
117
-`--small_exon_threshold`: dynamic exon length threshold to ignore for includsion and exclusion, default is 0.
114
118
-`--small_exon_threshold_high`: the upper bound of dynamic exon length threshold to ignore for includsion and exclusion, default is 80.
115
119
-`--truncation_match`: higher than this threshold at the truncation end will be adjusted to 1, default is 0.4.
In this step, SCOTCH will generate a new gene annotation file, including all novel isoforms identified. Set `--tast summary` to run this step. See `example/summary.sh` for an implementation in SLURM.
Finally, SCOTCH will generate gene- and isoform-level copunt matrix. Set `--tast 'count matrix'` to run this step. See `example/count.sh` for an implementation in SLURM.
137
142
138
143
-`--target`: the same with step1
139
-
- '--novel_read_n' filter out novel isoform is the number of reads mapped for the sample less than `novel_read_n`, and reads mapped to this novel isoform will be treated as uncategorized. Default is 20.
140
144
-`--workers`: number of threads for parallel computing.
145
+
- '--novel_read_n' filter out novel isoform is the number of reads mapped for the sample less than `novel_read_n`, and reads mapped to this novel isoform will be treated as uncategorized. Default is 20.
146
+
- '--novel_read_pct' ilter out novel isoforms with supporting read number less than % of gene coverage, default is 0.
141
147
-`--save_csv`/`--save_mtx`: these settings are used to set up output format. Saving csv files takes some time.(default is to save in both csv and mtx formats)
142
148
-`--group_novel`: whether group some novel isoforms that are potentially generated by read truncations together as one novel isoform.
0 commit comments