Skip to content

Commit db4dc17

Browse files
authored
Update README.md
added all --SV optionsto the manual
1 parent 3d197d3 commit db4dc17

File tree

1 file changed

+47
-37
lines changed

1 file changed

+47
-37
lines changed

README.md

Lines changed: 47 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -83,43 +83,53 @@ The reference is required for analysing cram files.
8383

8484
NOTE: It is important that you use the TIDDIT.py wrapper for SV detection. The TIDDIT binary in the TIDDIT/bin folder does not perform any clustering, it simply extract SV signatures into a tab file.
8585

86-
TIDDIT may be fine tuned by altering these optional parameters:
87-
-o O output prefix(default=output)
88-
-i I paired reads maximum allowed insert size. Pairs aligning
89-
on the same chr at a distance higher than this are
90-
considered candidates for SV (default= 99.9th percentile
91-
of insert size)
92-
-d D expected reads orientations, possible values "innie" (->
93-
<-) or "outtie" (<- ->). Default: major orientation
94-
within the dataset
95-
-p P Minimum number of supporting pairs in order to call a
96-
variation event (default 3)
97-
-r R Minimum number of supporting split reads to call a small
98-
variant (default 3)
99-
-q Q Minimum mapping quality to consider an alignment (default
100-
5)
101-
-Q Q Minimum regional mapping quality (default 20)
102-
-n N the ploidy of the organism,(default = 2)
103-
-e E clustering distance parameter, discordant pairs closer
104-
than this distance are considered to belong to the same
105-
variant(default = sqrt(insert-size*2)*12)
106-
-l L min-pts parameter (default=3),must be set >= 2
107-
-s S Number of reads to sample when computing library
108-
statistics(default=25000000)
109-
-z Z minimum variant size (default=100), variants smaller than
110-
this will not be printed ( z < 10 is not recomended)
111-
--force_ploidy force the ploidy to be set to -n across the entire genome
112-
(i.e skip coverage normalisation of chromosomes)
113-
--no_cluster Run only the TIDDIT signal extraction
114-
--debug rerun the tiddit clustering procedure
115-
--n_mask N_MASK exclude regions from coverage calculation if they contain
116-
more than this fraction of N (default = 0.5)
117-
--ref REF reference fasta, used for GC correction and for reading
118-
cram
119-
--p_ratio P_RATIO minimum discordant pair/normal pair ratio at the
120-
breakpoint junction(default=0.2)
121-
--r_ratio R_RATIO minimum split read/coverage ratio at the breakpoint
122-
junction(default=0.1)
86+
87+
TIDDIT may be fine-tuned by altering these optional parameters:
88+
89+
-o output prefix(default=output)
90+
91+
-i paired reads maximum allowed insert size. Pairs aligning
92+
on the same chr at a distance higher than this are
93+
considered candidates for SV (default= 99.9th percentile of insert size)
94+
95+
-d expected reads orientations, possible values "innie" (-> <-) or "outtie" (<- ->).
96+
Default: major orientation within the dataset
97+
98+
-p Minimum number of supporting pairs in order to call a variation event (default 3)
99+
100+
-r Minimum number of supporting split reads to call a small variant (default 3)
101+
102+
-q Minimum mapping quality to consider an alignment (default= 5)
103+
104+
-Q Minimum regional mapping quality (default 20)
105+
106+
-n the ploidy of the organism,(default = 2)
107+
108+
-e clustering distance parameter, discordant pairs closer
109+
than this distance are considered to belong to the same
110+
variant(default = sqrt(insert-size*2)*12)
111+
112+
-l min-pts parameter (default=3),must be set >= 2
113+
114+
-s Number of reads to sample when computing library statistics(default=25000000)
115+
116+
-z minimum variant size (default=100), variants smaller than
117+
this will not be printed ( z < 10 is not recomended)
118+
119+
--force_ploidy force the ploidy to be set to -n across the entire genome
120+
(i.e skip coverage normalisation of chromosomes)
121+
122+
--no_cluster Run only the TIDDIT signal extraction
123+
124+
--debug rerun the tiddit clustering procedure
125+
126+
--n_mask exclude regions from coverage calculation if they contain more than this fraction of N (default = 0.5)
127+
128+
--ref reference fasta, used for GC correction and for reading cram
129+
130+
--p_ratio minimum discordant pair/normal pair ratio at the breakpoint junction(default=0.2)
131+
132+
--r_ratio minimum split read/coverage ratio at the breakpoint junction(default=0.1)
123133

124134

125135

0 commit comments

Comments
 (0)