Skip to main content

Map genes and genome to the Global Microbial Gene Catalog (GMGC)

Project description

GMGC-mapper

Install with conda PyPI version gmgc_mapper_test Number of downloads License: MIT

Command line tool to query the Global Microbial Gene Catalog (GMGC).

Install

GMGC-mapper runs on Python 3.6-3.8 and requires prodigal to be available for genome mode.

Conda install

The easiest way to install GMGC-mapper is through bioconda, which will ensure all dependencies (including prodigal) are installed automatically:

conda install -c bioconda gmgc-mapper

pip install

Alternatively, GMGC-mapper is available from PyPI, so can be installed through pip:

pip install GMGC-mapper

Note that this does not install prodigal (which is necessary for the genome-based workflow).

Install from source

Finally, especially if you are retrieving the cutting edge version from Github, you can install with the standard

python setup.py install

Examples

  1. Input is a genome sequence.
gmgc-mapper -i input.fasta -o output
  1. Input is DNA/protein gene sequences
gmgc-mapper --nt-genes genes.fna --aa-genes genes.faa -o output

The nucleotide input is optional (but should be used if available so that the quality of the hits can be refined):

gmgc-mapper --aa-genes genes.faa -o output

If yout input is a metagenome, you can use NGLess for assembly and gene prediction. For more details, read the docs.

Output

The output folder will contain

  1. Outputs of gene prediction (prodigal).
  2. Complete data table, listing all the hits in GMGC, per gene.
  3. Complete table, listing all the genome bins (MAGs) that are found in the results.
  4. Human readable summary.

For more details, read the docs. A description of the outputs is also written to output folder for convenience.

Parameters

  • -i/--input: path to the input genome file(.fasta/.gz/.bz2).

  • -o/--output: Output directory (will be created if non-existent).

  • --nt-genes: path to the input DNA gene file(.fasta/.gz/.bz2).

  • --aa-genes: path to the input Protein gene file(.fasta/.gz/.bz2).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

GMGC-mapper-0.2.0.tar.gz (13.7 kB view details)

Uploaded Source

File details

Details for the file GMGC-mapper-0.2.0.tar.gz.

File metadata

  • Download URL: GMGC-mapper-0.2.0.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.20.1 setuptools/40.4.0 requests-toolbelt/0.9.1 tqdm/4.26.0 CPython/3.6.8

File hashes

Hashes for GMGC-mapper-0.2.0.tar.gz
Algorithm Hash digest
SHA256 49977835cd3af85c3ed45ba4fd2c173ad94249a9e90c56599cc342c95a001da6
MD5 4dfcfc030c286b6a896beb802843f528
BLAKE2b-256 27b94f686f1e3f43b0432d4fd63c888833e776fd828e8f602bfecb2265b331a2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page