view tools/mothur/collect.shared.xml @ 0:ee4fee239fe7 draft default tip

planemo upload commit 68a4fd4cc5332c57ac39bef73db224425af0706c-dirty

<tool profile="16.07" id="mothur_collect_shared" name="Collect.shared" version="@WRAPPER_VERSION@.0">
    <description>Generate collector's curves for calculators on OTUs</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements"/>
    <expand macro="version_command"/>
    <command detect_errors="aggressive"><![CDATA[
        echo 'collect.shared(
            shared=$otu,
            #if $label:
                label=${ str($label).replace(",","-") },
            #end if
            #if $calc:
                calc=${ str($calc).replace(",","-") },
            #end if
            #if $groups:
                groups=${ str($groups).replace(",","-") },
            #end if
            freq=$freq,
            all=true
        )'
        | sed 's/ //g'  ## mothur trips over whitespace
        | mothur &&

        ## move output files to correct destination
        prefix="$otu" &&
        mv mothur.*.logfile "$logfile" &&
        ## move everything with as suffix one of the calculators to cwd
        mv \${prefix%.dat}.{${str($calc).replace("shared","shared.")}} .
    ]]></command>
    <inputs>
        <param name="otu" type="data" format="mothur.shared" label="shared - OTU Shared"/>
        <param name="label" type="select" multiple="true" label="label - OTU Label filter">
            <expand macro="labeloptions"/>
        </param>
        <param name="groups" type="select" multiple="true" label="groups - Groups filter (uses all groups if none are selected)" help="To filter: select select at least 2 groups">
            <options>
                <filter type="data_meta" ref="otu" key="groups"/>
            </options>
        </param>
        <param name="calc" type="select" multiple="true" label="calc - Calculators (Uses defaults if none are selected)">
            <option value="sharedsobs" selected="true">sharedsobs - Shared community richness the observed richness shared between two or more samples</option>
            <option value="sharedchao" selected="true">sharedchao - Shared community richness the two or more sample shared Chao1 richness estimator</option>
            <option value="sharedace" selected="true">sharedace - Shared community richness the two sample shared ACE richness estimator</option>
            <option value="anderberg">anderberg - Community Membership Similarity the Anderberg similarity coefficient</option>
            <option value="jclass" selected="true">jclass - Community Membership Similarity the traditional Jaccard similarity coefficient based on the observed richness</option>
            <option value="jest" selected="true">jest - Community Membership Similarity the Jaccard similarity coefficient based on the Chao1 estimated richnesses</option>
            <option value="kulczynski">kulczynski - Community Membership Similarity the Kulczynski similarity coefficient</option>
            <option value="kulczynskicody">kulczynskicody - Community Membership Similarity the Kulczynski-Cody similarity coefficient</option>
            <option value="kstest">kstest - Community Membership Similarity Kolmogorov-Smirnov test</option>
            <option value="lennon">lennon - Community Membership Similarity the Lennon similarity coefficient</option>
            <option value="ochiai">ochiai - Community Membership Similarity the Ochiai similarity coefficient</option>
            <option value="sorclass" selected="true">sorclass - Community Membership Similarity the Sorenson similarity coefficient based on the observed richness</option>
            <option value="sorest" selected="true">sorest - Community Membership Similarity the Sorenson similarity coefficient based on the Chao1 estimated richnesses</option>
            <option value="whittaker">whittaker - Community Membership Similarity the Whittaker similarity coefficient</option>
            <option value="hamming">hamming - Community Membership Similarity -</option>
            <option value="memchi2">memchi2 - Community Membership Similarity -</option>
            <option value="memchord">memchord - Community Membership Similarity -</option>
            <option value="memeuclidean">memeuclidean - Community Membership Similarity -</option>
            <option value="mempearson">mempearson - Community Membership Similarity -</option>
            <option value="braycurtis">braycurtis - Community Structure Similarity the Bray-Curtis similarity coefficient</option>
            <option value="jabund" selected="true">jabund - Community Structure Similarity the abundance-based Jaccard similarity coefficient</option>
            <option value="morisitahorn">morisitahorn - Community Structure Similarity the Morisita-Horn similarity coefficient</option>
            <option value="sorabund" selected="true">sorabund - Community Structure Similarity the abundance-based Sorenson similarity coefficient</option>
            <option value="thetan" selected="true">thetan - Community Structure Similarity the Smith theta similarity coefficient</option>
            <option value="thetayc" selected="true">thetayc - Community Structure Similarity the Yue &amp; Clayton theta similarity coefficient</option>
            <option value="canberra">canberra - Community Structure Similarity -</option>
            <option value="gower">gower - Community Structure Similarity -</option>
            <option value="hellinger">hellinger - Community Structure Similarity -</option>
            <option value="manhattan">manhattan - Community Structure Similarity -</option>
            <option value="odum">odum - Community Structure Similarity -</option>
            <option value="soergel">soergel - Community Structure Similarity -</option>
            <option value="spearman">spearman - Community Structure Similarity -</option>
            <option value="speciesprofile">speciesprofile - Community Structure Similarity -</option>
            <option value="structchi2">structchi2 - Community Structure Similarity -</option>
            <option value="structchord">structchord - Community Structure Similarity -</option>
            <option value="structeuclidean">structeuclidean - Community Structure Similarity -</option>
            <option value="structkulczynski">structkulczynski - Community Structure Similarity -</option>
            <option value="structpearson">structpearson - Community Structure Similarity -</option>
            <option value="sharednseqs">sharednseqs - Utility the number of sequences in two samples</option>
        </param>
        <param name="freq" type="float" value="100" label="freq - indicates when to output your data" help="by default it is set to 100. But you can set it to a percentage of the number of sequence. For example freq=0.10, means 10%" min="0.0" max="100.0"/>
    </inputs>
    <outputs>
        <data name="logfile" format="txt" label="${tool.name} on ${on_string}: logfile"/>
        <collection name="calcfiles" type="list" label="${tool.name} on ${on_string}: calculators">
            <discover_datasets pattern=".*?\.(?P&lt;designation&gt;.*)" format="tabular"/>
        </collection>
    </outputs>
    <tests>
        <test><!-- test default settings -->
            <param name="otu" value="amazon.an.shared" ftype="mothur.shared"/>
            <output_collection name="calcfiles" count="11">
                <element name="jest" md5="22e97fbdbdadf3c4748d0f7c4d526855" ftype="tabular"/>
            </output_collection>
            <expand macro="logfile-test"/>
        </test>
        <test><!-- test with group and label select and all calculators -->
            <param name="otu" value="amazon.an.shared" ftype="mothur.shared"/>
            <param name="groups" value="forest,pasture"/>
            <param name="label" value="0.03,0.05,0.22"/>
            <param name="calc" value="sharedsobs,sharedchao,sharedace,anderberg,jclass,jest,kulczynski,kulczynskicody,kstest,lennon,ochiai,sorclass,sorest,whittaker,hamming,memchi2,memchord,memeuclidean,mempearson,braycurtis,jabund,morisitahorn,sorabund,thetan,thetayc,canberra,gower,hellinger,manhattan,odum,soergel,spearman,speciesprofile,structchi2,structchord,structeuclidean,structkulczynski,structpearson,sharednseqs"/>
            <output_collection name="calcfiles" count="39">
                <element name="jest" md5="1289eac7fdcfb42eaf4ee35deb6fb0a4" ftype="tabular"/>
            </output_collection>
            <expand macro="logfile-test"/>
        </test>
    </tests>
    <help>
<![CDATA[

@MOTHUR_OVERVIEW@

**Command Documenation**

The collect.shared_ command generates collector's curves for calculators_, which describe the similarity between communities or their shared richness. Collector's curves describe how richness or diversity change as you sample additional individuals. If a collector's curve becomes parallel to the x-axis, you can be reasonably confident that you have done a good job of sampling and can trust the last value in the curve.  For calc parameter choices see: http://www.mothur.org/wiki/Calculators

.. _calculators: http://www.mothur.org/wiki/Calculators
.. _collect.shared: http://www.mothur.org/wiki/Collect.shared
]]>
    </help>
    <expand macro="citations"/>
</tool>