diff transit_resampling.xml @ 5:3fcb70c1ca78 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/transit/ commit 73c6b2baf9dda26c6809a4f36582f7cbdb161ea1
author iuc
date Mon, 22 Apr 2019 14:40:33 -0400
parents 7288ac4e8583
children 8ab1c8c909a7
line wrap: on
line diff
--- a/transit_resampling.xml	Wed Apr 03 14:43:41 2019 -0400
+++ b/transit_resampling.xml	Mon Apr 22 14:40:33 2019 -0400
@@ -46,110 +46,101 @@
         </test>
     </tests>
 
-    <help><![CDATA[
+    <help>
+<![CDATA[.. class:: infomark
+
+**What it does**
+
+-------------------
+
+
+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.
+
+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.
+
+
+Note : Can be used for both Himar1 and Tn5 datasets
+
+
+-------------------
+
+**Inputs**
+
+-------------------
+
+Input files for Resampling need to be:
+
+-   .wig files : Tabulated files containing one column with the TA site coordinate and one column with the read count at this site.
+-   annotation .prot_table : Annotation file generated by the `Convert Gff3 to prot_table for TRANSIT` tool.
 
 
-            .. class:: infomark
+-------------------
+
+**Parameters**
+
+-------------------
+
+Optional Arguments:
 
-        **What it does**
-
-        -------------------
+-s <integer>    :=  Number of samples. Default: 10000
+-n <string>     :=  Normalization method. Default: TTR
+-h              :=  Output histogram of the permutations for each gene. Default: Off.
+-a              :=  Perform adaptive resampling. Default: Off.
+-ez             :=  Exclude rows with zero accross conditions. Default: Off
+--pc            :=  Pseudocounts to be added at each site. Default: 0
+-l              :=  Perform LOESS Correction; Helps remove possible genomic position bias. Default: Off.
+--iN <float>     :=  Ignore TAs occuring at given fraction of the N terminus. Default: 0.0
+--iC <float>     :=  Ignore TAs occuring at given fraction of the C terminus. Default: 0.0
+--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.
+--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.
 
 
+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:
 
-        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.
-
-        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.
+-   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.
+-   Output Histograms:Determines whether to output .png images of the histograms obtained from resampling the difference in read-counts.
+-   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.
+-   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).
+-   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.
 
 
-        Note : Can be used for both Himar1 and Tn5 datasets
+-------------------
+
+**Outputs**
+
+-------------------
+
+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.
+
+
+=============================================   ========================================================================================================================
+**Column Header**                               **Column Definition**
+---------------------------------------------   ------------------------------------------------------------------------------------------------------------------------
+Orf                                             Gene ID
+Name                                            Gene Name
+Desc                                            Gene Description
+N                                               Number of TA sites in the gene.
+TAs Hit                                         Number of TA sites with at least one insertion.
+Sum Rd 1                                        Sum of read counts in condition 1.
+Sum Rd 2                                        Sum of read counts in condition 2.
+Delta Rd                                        Difference in the sum of read counts.
+p-value                                         P-value calculated by the permutation test.
+p-adj.                                          Adjusted p-value controlling for the FDR (Benjamini-Hochberg)
+=============================================   ========================================================================================================================
 
 
 
-        -------------------
-
-        **Inputs**
-
-        -------------------
-
-        Input files for Resampling need to be:
-
-                        -   .wig files : Tabulated files containing one column with the TA site coordinate and one column with the read count at this site.
-                        -   annotation .prot_table : Annotation file generated by the `Convert Gff3 to prot_table for TRANSIT` tool.
-
-
-        -------------------
-
-        **Parameters**
-
-        -------------------
-
-                Optional Arguments:
+-------------------
 
-                -s <integer>    :=  Number of samples. Default: -s 10000
-                -n <string>     :=  Normalization method. Default: -n TTR
-                -h              :=  Output histogram of the permutations for each gene. Default: Turned Off.
-                -a              :=  Perform adaptive resampling. Default: Turned Off.
-                -ez             :=  Exclude rows with zero accross conditions. Default: Turned off
+**More Information**
 
-                --pc            :=  Pseudocounts to be added at each site.
-                -l              :=  Perform LOESS Correction; Helps remove possible genomic position bias.
-                                    Default: Turned Off.
-                --iN <float>     :=  Ignore TAs occuring at given fraction of the N terminus. Default: -iN 0.0
-                --iC <float>     :=  Ignore TAs occuring at given fraction of the C terminus. Default: -iC 0.0
-                --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.
-                --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.
-
-
-        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:
+-------------------
 
-            -   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.
-            -   Output Histograms:Determines whether to output .png images of the histograms obtained from resampling the difference in read-counts.
-            -   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.
-            -   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).
-            -   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.
-
-
-        -------------------
-
-        **Outputs**
-
-        -------------------
-
-        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.
+See  `TRANSIT documentation`
 
-                        =============================================   ========================================================================================================================
-                        **Column Header**                               **Column Definition**
-                        ---------------------------------------------   ------------------------------------------------------------------------------------------------------------------------
-                        Orf                                             Gene ID
-                        Name                                            Gene Name
-                        Desc                                            Gene Description
-                        N                                               Number of TA sites in the gene.
-                        TAs Hit                                         Number of TA sites with at least one insertion.
-                        Sum Rd 1                                        Sum of read counts in condition 1.
-                        Sum Rd 2                                        Sum of read counts in condition 2.
-                        Delta Rd	                                    Difference in the sum of read counts.
-                        p-value                                         P-value calculated by the permutation test.
-                        p-adj.                                          Adjusted p-value controlling for the FDR (Benjamini-Hochberg)
-                        =============================================   ========================================================================================================================
-
-
-
-        -------------------
-
-        **More Information**
-
-        -------------------
-
-                See  `TRANSIT documentation`
-
-                       - TRANSIT: https://transit.readthedocs.io/en/latest/index.html
-                       - `TRANSIT Gumbel`: https://transit.readthedocs.io/en/latest/transit_methods.html#re-sampling
-        ]]></help>
+- TRANSIT: https://transit.readthedocs.io/en/latest/index.html
+- `TRANSIT Gumbel`: https://transit.readthedocs.io/en/latest/transit_methods.html#re-sampling
+]]></help>
 
     <expand macro="citations" />
 </tool>