A tool to generate pathway modules profiles from meta-omic samples.
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
GMMs.v1.07.txt
LICENSE
README.md
gmms.jar

README.md

GMMs

A tool to generate pathway modules profiles from meta-omic samples.

Prerequisites

Usage

java -jar gmms.jar [-a ] [-c ] [-d ] [-e ] [-h] [-i ] [--ignore-taxonomic-info] [-n] [-o ] [-s ] [-t ] [--Xdistribute]

 -a,--annotation <ANNOTATION>             Input file annotation.
                                          Use 1 for taxonomic annotation followed by orthologs files or 2 for orthologs only.
                                          Defaults to 1
 -c,--coverage <COVERAGE>                 The minimum coverage cut-off to accept a module [0.0 to 1.0].
                                          Defaults to -1, where the coverage is learned from the coverage distribution of all modules
 -d,--database <FILE>                     The path to the modules database
 -e,--export-format <FORMAT>              The output file format.
                                          Use 1 for single tab separated files containing module id, abundance and coverage. Use 2 for an abundance and a coverage matrices.
                                          Defaults to 1.
 -h,--help                                Show this help message and exit
 -i,--input <PATH>                        Path to the input matrix or input directory with one file per sample
    --ignore-taxonomic-info               Ignore taxonomic info from input file and infer modules for the whole metagenome instead
 -n,--normalize-by-length                 Divide module score by its length. When combined with a median estimator, missing reactions (score = 0 )
                                          are included when estimating the median. If the estimated score equals zero then it is replaced by
                                          the minimum observed reaction score. If this option is specified, score calculation is based only on
                                          the number of observed reactions
 -o,--output-dir <DIRECTORY>              Path to the output directory
 -s,--score-estimator <SCORE-ESTIMATOR>   The score estimatore.
                                          Accepted values are [median|average].
                                          Defaults to median
 -t,--threads <THREADS>                   Number of threads to use when mapping the modules.
                                          Defaults to 1
    --Xdistribute                         Experimental feature - When an ortholog is shared, distribute its abundance by the count of sharing modules.

License

Academic Non-commercial Software License Agreement

Related publications and versionning

For the Vieira-Silva et al. 2016 paper, we used version 8cf60cc735 of this repository.

Developed by Youssef Darzi (@omixer)