Florent Angly > Bio-Community-0.001000 > bc_rarefy


Annotate this POD


View/Report Bugs
Source   Latest Release: Bio-Community-0.001007


bc_rarefy - Rarefy communities


  bc_rarefy -input_files   my_communities.generic   \
            -output_prefix my_converted_communities \
            -sample_size   1000


This script reads a file containing biological communities and performs rarefaction, i.e. repeatedly takes a random subset of the community members, in order to normalize communities by member count. Rarefaction is useful to simulate an identical sampling effort for all communities. The output is a file containing rarefied, representative communities (integers). See Bio::Community::Tools::Rarefier for more information.



Input file containing the communities to rarefy. When providing communities in a format that supports only one community per file (e.g. gaas), you can provide multiple input files.


-op <output_prefix> | -output_prefix <output_prefix>

Path and prefix for the output files. Default: output_prefix.default

-ss <sample_size> | -sample_size <sample_size>

Number of members to randomly take at each bootstrap iteration. If omitted, the sample size defaults to the size (member count) of the smallest community.

-dt <dist_threshold> | -dist_threshold <dist_threshold>

Keep doing bootstrap iterations until the distance between the current average community and the average community at the previous iteration becomes less than the specified threshold. Default: dist_threshold.default

-nr <num_repetitions> | -num_repetitions <num_repetitions>

Perform the specified number of bootstrap iterations instead of a dynamic number of iterations based on a distance threshold.

-wa <write_average> | -write_average <write_average>

Write the average bootstraped communities (decimals) in addition to the rarefied communities (integers): 1 is yes, 0 is no. Default: write_average.default


Mailing Lists


Your participation is much appreciated.

  bioperl-l@bioperl.org                  - General discussion


Please direct usage questions or support issues to the mailing list:



Reporting Bugs



AUTHOR - Florent Angly ^

Email florent.angly@gmail.com

syntax highlighting: