Giter VIP home page Giter VIP logo

autometa's Introduction

Autometa

GitHub tag (latest SemVer)

An automated binning pipeline for single metagenomes, in particular host-associated and highly complex ones. Autometa is copyright 2020 Ian J. Miller, Evan Rees, Izaak Miller and Jason C. Kwan, and is released under the GNU Affero General Public License v3 (see LICENSE.txt). If you find Autometa useful to your work, please cite:

Miller, I. J.; Rees, E. R.; Ross, J.; Miller, I.; Baxa, J.; Lopera, J.; Kerby, R. L.; Rey, F. E.; Kwan, J. C. Autometa: Automated extraction of microbial genomes from individual shotgun metagenomes. Nucleic Acids Research, 2019. DOI: https://doi.org/10.1093/nar/gkz148

Documentation

Documentation Status

Full documentation is hosted on autometa.readthedocs.io

Quickstart

๐Ÿš Bash workflow

Install with Conda Badge Platforms Badge Downloads Badge

1. Setup env

Install into your current env...
conda install -c bioconda autometa
... or create a new env
conda create -n autometa -c bioconda autometa

2. Download the bash workflow template, autometa.sh

3. Edit the input parameters

4. Run the workflow

๐Ÿ Nextflow Workflow

Nextflow

1. Setup env

๐Ÿง‘โ€๐ŸŽ“ This workflow requires only nextflow and nf-core be installed.

Install into your current env...
conda env update -n <your-env> --file=https://raw.githubusercontent.com/KwanLab/Autometa/main/nextflow-env.yml
... or create a new env
conda env create --file=https://raw.githubusercontent.com/KwanLab/Autometa/main/nextflow-env.yml
# Activate the env after creation
conda activate autometa-nf

2. Launch and run the workflow

nf-core launch KwanLab/Autometa

For developers

Contributing Guidelines GitHub good first issues

GitHub language count GitHub top language codecov


This pipeline uses code and infrastructure developed and maintained by the nf-core community, reused here under the MIT license.

The nf-core framework for community-curated bioinformatics pipelines.

Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.

Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x. In addition, references of tools and data used in this pipeline are as follows:

autometa's People

Contributors

jason-c-kwan avatar evanroyrees avatar ijmiller2 avatar sidduppal avatar chanana avatar chasemc avatar samche42 avatar maxibor avatar ajlail98 avatar hyphaltip avatar chtsai0105 avatar shaneroesemann avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.