Mercurial > repos > florianbegusch > qiime2_suite
diff qiime2-2020.8/qiime_diversity-lib_beta-passthrough.xml @ 20:d93d8888f0b0 draft
Uploaded
author | florianbegusch |
---|---|
date | Fri, 04 Sep 2020 12:44:24 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/qiime2-2020.8/qiime_diversity-lib_beta-passthrough.xml Fri Sep 04 12:44:24 2020 +0000 @@ -0,0 +1,103 @@ +<?xml version="1.0" ?> +<tool id="qiime_diversity-lib_beta-passthrough" name="qiime diversity-lib beta-passthrough" + version="2020.8"> + <description>Beta Passthrough (non-phylogenetic)</description> + <requirements> + <requirement type="package" version="2020.8">qiime2</requirement> + </requirements> + <command><![CDATA[ +qiime diversity-lib beta-passthrough + +--i-table=$itable + +--p-metric=$pmetric + +--p-pseudocount=$ppseudocount + +#if str($pnjobs) != 'None': +--p-n-jobs=$pnjobs +#end if + +--o-distance-matrix=odistancematrix + +#if str($examples) != 'None': +--examples=$examples +#end if + +; +cp odistancematrix.qza $odistancematrix + + ]]></command> + <inputs> + <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] The feature table containing the samples over which beta diversity should be computed. [required]" name="itable" optional="False" type="data" /> + <param label="--p-metric: " name="pmetric" optional="False" type="select"> + <option value="euclidean">euclidean</option> + <option value="cityblock">cityblock</option> + <option value="matching">matching</option> + <option value="russellrao">russellrao</option> + <option value="sokalmichener">sokalmichener</option> + <option value="kulsinski">kulsinski</option> + <option value="hamming">hamming</option> + <option value="chebyshev">chebyshev</option> + <option value="yule">yule</option> + <option value="dice">dice</option> + <option value="canberra_adkins">canberra_adkins</option> + <option value="rogerstanimoto">rogerstanimoto</option> + <option value="cosine">cosine</option> + <option value="minkowski">minkowski</option> + <option value="correlation">correlation</option> + <option value="sokalsneath">sokalsneath</option> + <option value="seuclidean">seuclidean</option> + <option value="canberra">canberra</option> + <option value="jensenshannon">jensenshannon</option> + <option value="sqeuclidean">sqeuclidean</option> + <option value="aitchison">aitchison</option> + </param> + <param label="--p-pseudocount: INTEGER Range(1, None) A pseudocount to handle zeros for compositional metrics. This is ignored for non-compositional metrics. [default: 1]" min="1" name="ppseudocount" optional="True" type="integer" value="1" /> + <param label="--p-n-jobs: " name="pnjobs" optional="True" type="select"> + <option selected="True" value="None">Selection is Optional</option> + <option value="Int % Range(1">Int % Range(1</option> + <option value="None">None</option> + </param> + <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" /> + + </inputs> + + <outputs> + <data format="qza" label="${tool.name} on ${on_string}: distancematrix.qza" name="odistancematrix" /> + + </outputs> + + <help><![CDATA[ +Beta Passthrough (non-phylogenetic) +############################################################### + +Computes a distance matrix for all pairs of samples in a feature table +using the scikit-bio implementation of the selected beta diversity metric. + +Parameters +---------- +table : FeatureTable[Frequency] + The feature table containing the samples over which beta diversity + should be computed. +metric : Str % Choices('yule', 'seuclidean', 'sokalmichener', 'aitchison', 'canberra_adkins', 'sokalsneath', 'hamming', 'canberra', 'jensenshannon', 'cityblock', 'russellrao', 'minkowski', 'euclidean', 'kulsinski', 'cosine', 'sqeuclidean', 'correlation', 'dice', 'rogerstanimoto', 'chebyshev', 'matching') + The beta diversity metric to be computed. +pseudocount : Int % Range(1, None), optional + A pseudocount to handle zeros for compositional metrics. This is + ignored for non-compositional metrics. +n_jobs : Int % Range(1, None) | Str % Choices('auto'), optional + The number of concurrent jobs to use in performing this calculation. + May not exceed the number of available physical cores. If n_jobs = + 'auto', one job will be launched for each identified CPU core on the + host. + +Returns +------- +distance_matrix : DistanceMatrix + The resulting distance matrix. + ]]></help> + <macros> + <import>qiime_citation.xml</import> + </macros> + <expand macro="qiime_citation"/> +</tool> \ No newline at end of file