annotate mothur/tools/mothur/summary.shared.xml @ 13:4f797d3eee3a

Change default processor counts to 8, mothur_wrapper.py can overide processors allocated with ENVIRONMENT variable MOTHUR_MAX_PROCESSORS

<tool id="mothur_summary_shared" name="Summary.shared" version="1.20.0"  force_history_refresh="True">
 <description>Summary of calculator values for OTUs</description>
 <command interpreter="python">
  mothur_wrapper.py 
  --cmd='summary.shared'
  --result='^mothur.\S+\.logfile$:'$logfile,'^\S+\.summary$:'$summary
  --outputdir='$logfile.extra_files_path'
  --datasetid='$logfile.id' --new_file_path='$__new_file_path__'
  --new_datasets='^\S+?\.((\S+)\.(unique|[0-9.]*)\.dist)$:lower.dist'
  --shared=$otu
  #if $groups.__str__ != "None" and len($groups.__str__) > 0:
   --groups=$groups
  #end if
  #if $label.__str__ != "None" and len($label.__str__) > 0:
   --label='$label'
  #end if
  #if $calc.__str__ != "None" and len($calc.__str__) > 0:
   --calc='$calc'
  #end if
  $all
  $distance
  --processors=8
 </command>
 <inputs>
  <param name="otu" type="data" format="shared" label="shared - OTU Shared"/>
  <param name="label" type="select" label="label - OTU Labels" multiple="true">
   <options from_dataset="otu">
    <column name="name" index="0"/>
    <column name="value" index="0"/>
    <filter type="static_value" name="ignore_header" keep="False" column="0" value = "label"/>
    <filter type="unique_value" name="unq_lbl" column="0" />
   </options>
  </param>
  <param name="groups" type="select" label="groups - Pairwise comparision groups" multiple="true">
   <options from_dataset="otu">
    <column name="name" index="1"/>
    <column name="value" index="1"/>
    <filter type="static_value" name="ignore_header" keep="False" column="1" value = "Group"/>
    <filter type="unique_value" name="unq_grp" column="1" />
   </options>
  </param>
  <param name="calc" type="select" label="calc - Calculators (Uses defaults if none selected)" multiple="true">
   <options from_file="mothur_calculators.loc">
     <column name="mult" index="1"/>
     <column name="name" index="0"/>
     <column name="value" index="0"/>
     <filter type="static_value" name="mult" column="1" value="shared" />
   </options>
  </param>
  <param name="all" type="boolean" truevalue="--all=true" falsevalue="" checked="false" label="all - Include RAM intensive sharedsobs and sharedchao calculations"/>
  <param name="distance" type="boolean" truevalue="--distance=true" falsevalue="" checked="false" label="distance - Output a distance file for each calculator at each label"/>
 </inputs>
 <outputs>
  <data format="html" name="logfile" label="${tool.name} on ${on_string}: logfile" />
  <data format="tabular" name="summary" label="${tool.name} on ${on_string}: shared.summary" />
 </outputs>
 <requirements>
  <requirement type="binary">mothur</requirement>
 </requirements>
 <tests>
 </tests>
 <help>
**Mothur Overview**

Mothur_, initiated by Dr. Patrick Schloss and his software development team
in the Department of Microbiology and Immunology at The University of Michigan,
provides bioinformatics for the microbial ecology community.

.. _Mothur: http://www.mothur.org/wiki/Main_Page

**Command Documenation**

The summary.shared_ command produce a summary file that has the calculator value for each line in the OTU data of the shared_ file and for all possible comparisons between the different groups in the group_ file.  This can be useful if you aren't interested in generating collector's or rarefaction curves for your multi-sample data analysis. It would be worth your while, however, to look at the collector's curves for the calculators you are interested in to determine how sensitive the values are to sampling. If the values are not sensitive to sampling, then you can trust the values. Otherwise, you need to keep sampling.  For calc parameter choices see: http://www.mothur.org/wiki/Calculators  

.. _shared: http://www.mothur.org/wiki/Shared_file
.. _group: http://www.mothur.org/wiki/Group_file
.. _summary.shared: http://www.mothur.org/wiki/Summary.shared

 </help>
</tool>