comparison transit_resampling.xml @ 3:b33af081b02e draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/transit/ commit 4730eda34222a432a14bf1d1dd090b15e61a494c-dirty
author iuc
date Tue, 12 Mar 2019 14:59:37 -0400
parents 1d1ca6b30fbb
children 7288ac4e8583
comparison
equal deleted inserted replaced
2:173bf0f6ca1e 3:b33af081b02e
42 <param name="samples" value="1000" /> 42 <param name="samples" value="1000" />
43 <param name="burnin" value="100" /> 43 <param name="burnin" value="100" />
44 <output name="sites" file="resampling-sites1.txt" ftype="tabular" compare="sim_size" /> 44 <output name="sites" file="resampling-sites1.txt" ftype="tabular" compare="sim_size" />
45 </test> 45 </test>
46 </tests> 46 </tests>
47
47 <help> 48 <help>
48 <![CDATA[ 49 <![CDATA[.. class:: infomark
50
51 **What it does**
52
53 -------------------
54
55
49 The re-sampling method is a comparative analysis the allows that can be used to determine conditional essentiality of genes. It is based on a permutation test, and is capable of determining read-counts that are significantly different across conditions. 56 The re-sampling method is a comparative analysis the allows that can be used to determine conditional essentiality of genes. It is based on a permutation test, and is capable of determining read-counts that are significantly different across conditions.
57
58 This technique has yet to be formally published in the context of differential essentiality analysis. Briefly, the read-counts at each genes are determined for each replicate of each condition. The total read-counts in condition A is subtracted from the total read counts at condition B, to obtain an observed difference in read counts. The TA sites are then permuted for a given number of “samples”. For each one of these permutations, the difference is read-counts is determined. This forms a null distribution, from which a p-value is calculated for the original, observed difference in read-counts.
59
60
61 Note : Can be used for both Himar1 and Tn5 datasets
62
63
64 -------------------
65
66 **Inputs**
67
68 -------------------
69
70 Input files for Resampling need to be:
71
72 - .wig files : Tabulated files containing one column with the TA site coordinate and one column with the read count at this site.
73 - annotation .prot_table : Annotation file generated by the `Convert Gff3 to prot_table for TRANSIT` tool.
74
75
76 -------------------
77
78 **Parameters**
79
80 -------------------
81
82 Optional Arguments:
83
84 -s <integer> := Number of samples. Default: 10000
85 -n <string> := Normalization method. Default: TTR
86 -h := Output histogram of the permutations for each gene. Default: Off.
87 -a := Perform adaptive resampling. Default: Off.
88 -ez := Exclude rows with zero accross conditions. Default: Off
89 --pc := Pseudocounts to be added at each site.:
90 -l := Perform LOESS Correction; Helps remove possible genomic position bias. Default: Off.
91 --iN <float> := Ignore TAs occuring at given fraction of the N terminus. Default: 0.0
92 --iC <float> := Ignore TAs occuring at given fraction of the C terminus. Default: 0.0
93 --ctrl_lib := String of letters representing library of control files in order e.g. 'AABB': Default empty. Letters used must also be used in --exp_lib. If non-empty, resampling will limit permutations to within-libraries.
94 --exp_lib := String of letters representing library of experimental files in order e.g. 'ABAB': Default empty. Letters used must also be used in --ctrl_lib. If non-empty, resampling will limit permutations to within-libraries.
95
96
97 The resampling method is non-parametric, and therefore does not require any parameters governing the distributions or the model. The following parameters are available for the method:
98
99 - Samples: The number of samples (permutations) to perform. The larger the number of samples, the more resolution the p-values calculated will have, at the expense of longer computation time. The re-sampling method runs on 10,000 samples by default.
100 - Output Histograms:Determines whether to output .png images of the histograms obtained from resampling the difference in read-counts.
101 - Adaptive Resampling: An optional “adaptive” version of resampling which accelerates the calculation by terminating early for genes which are likely not significant. This dramatically speeds up the computation at the cost of less accurate estimates for those genes that terminate early (i.e. deemed not significant). This option is OFF by default.
102 - Include Zeros: Select to include sites that are zero. This is the preferred behavior, however, unselecting this (thus ignoring sites that) are zero accross all dataset (i.e. completely empty), is useful for decreasing running time (specially for large datasets like Tn5).
103 - Normalization Method: Determines which normalization method to use when comparing datasets. Proper normalization is important as it ensures that other sources of variability are not mistakenly treated as real differences. See the Normalization section for a description of normalization method available in TRANSIT.
104
105
106 -------------------
107
108 **Outputs**
109
110 -------------------
111
112 The re-sampling method outputs a tab-delimited file with results for each gene in the genome. P-values are adjusted for multiple comparisons using the Benjamini-Hochberg procedure (called “q-values” or “p-adj.”). A typical threshold for conditional essentiality on is q-value < 0.05.
113
114
115 ============================================= ========================================================================================================================
116 **Column Header** **Column Definition**
117 --------------------------------------------- ------------------------------------------------------------------------------------------------------------------------
118 Orf Gene ID
119 Name Gene Name
120 Desc Gene Description
121 N Number of TA sites in the gene.
122 TAs Hit Number of TA sites with at least one insertion.
123 Sum Rd 1 Sum of read counts in condition 1.
124 Sum Rd 2 Sum of read counts in condition 2.
125 Delta Rd Difference in the sum of read counts.
126 p-value P-value calculated by the permutation test.
127 p-adj. Adjusted p-value controlling for the FDR (Benjamini-Hochberg)
128 ============================================= ========================================================================================================================
129
130
131
132 -------------------
133
134 **More Information**
135
136 -------------------
137
138 See `TRANSIT documentation`
139
140 - TRANSIT: https://transit.readthedocs.io/en/latest/index.html
141 - `TRANSIT Gumbel`: https://transit.readthedocs.io/en/latest/transit_methods.html#re-sampling
50 ]]></help> 142 ]]></help>
143
51 <expand macro="citations" /> 144 <expand macro="citations" />
52 </tool> 145 </tool>