CDCgov/MaRS

Name: MaRS

Owner: Centers for Disease Control and Prevention Surveillance Strategy

Description: null

Created: 2017-12-06 16:46:57.0

Updated: 2018-04-30 14:30:56.0

Pushed: 2018-05-09 17:17:53.0

Homepage: https://cdcgov.github.io/MaRS/

Size: 700153

Language: Java

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

MaRS (Malaria Resistance Surveillance)

The emergence of resistance to all currently available antimalarial drugs in multiple regions of the world represents a current global public health challenge. In order to monitor and address this situation, faster and more effective surveillance tools are required to track and monitor the emergence and evolution of drug resistance in malaria. The Malaria Resistance Surveillance (MaRS) project aims to address this challenge by collating and mapping genetic polymorphisms associated with drug resistance in malaria around the world. The project achieves this by employing a targeted amplicon deep sequencing (TADS) approach Lab Protocol to detect single nucleotide polymorphisms on all major malaria drug resistance genes associated genes in samples sourced from travelers returning to the US from overseas, as well as samples actively collected in collaboration with partners from other countries.

Data for this project can be found at the following link NCBI BioProject. Collaborators are encouraged to submit their own data using this NCBI BioProject

The Malaria Resistance Surveillance or MaRS analysis pipline, is an attempt at standardizing the workflow for identifying both known and new polymorhisms in P.falciparum genes associated with drug resistance.

If you end up using MaRS in your workflow, please cite this study:

-Generation Sequencing and Bioinformatics Protocol for Malaria Drug Resistance Marker Surveillance.

ndzic E, Ravishankar S, Kelley J, Patel D, Plucinski M, Schmedes S, Ljolje D, Clemons B, 
son-Antenucci S, Arguin PM, Lucchi NW, Vannberg F, Udhayakumar V.

microb Agents Chemother. 2018 Mar 27;62(4). pii: e02474-17. doi: 10.1128/AAC.02474-17. Print 2018 Apr.

Setup

Getting started
  1. Download git repository:

Clone the master branch of this repository.

clone https://github.com/CDCgov/MaRS.git
  1. Setup virtualenv for Python3:

MaRS requires python3 to be installed with pip available. Please make sure this is available on the system. To avoid clashes with system version of required python modules, we recommend using a virtualenv Run the following command to install virtualenv, if you already have virtualenv installed

on3 -m pip install virtualenv
ualenv mars_env                   # Setup mars virtual environment
ce mars_env/bin/activate          # Activate virtual environment

If successfully activated, you should see now (mars_venv) in front of your terminal username.

  1. Installing python dependencies and downloading third party libraries:

MaRS uses many python modules Run the following command to install the dependencies

 install pyvcf pysam matplotlib seaborn pandas numpy xlrd openpyxl
 list --format=columns
  1. Your first analysis:

Follow the directory structure listed below and use the run script included with the bundle to run your first analysis.

un.sh <path to experiment folder> <path to output folder>

For example if you have stored your fastq files in `fq/folder and you want to store the results in the folder ``local/```. You can run the following command from the MaRS directory.

un.sh fq/ local/
Depdencies:
  1. Python3.4
  2. Java (Version : 9.0.1)
  3. Pandas (Version : > 0.22.0)
  4. Numpy (Version : > 1.13.3)
  5. Seaborn (Version : > 0.8.1)
  6. Openpyxl (Version : > 2.4.9)
  7. BBMap (Version : v35.92)
  8. BWA (Version : 0.7.12)
  9. Bowtie2 (Version : 2.3.3.1)
  10. Snap (Version : 1.0beta23)
  11. Samtools (Version : 1.3.1)
  12. Bcftools (Version : 1.3.1)
  13. GATK (Version : 3.6-0-g89b7209)
Version Histroy
Directory structure:
  1. fq
  2. Contains all the input fastq files
  3. lib
  4. Contains the binaries for all the tools that MaRS can run
  5. local
  6. Local output folder
  7. pyamd
  8. Contains all the MaRS classes.
  9. ref
  10. Contains reference sequences. For the current version, the ref folder must also contain the alignment indicies.
Output directory structure:
Public Domain

This repository constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. This repository is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication. All contributions to this repository will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.

License

The repository utilizes code licensed under the terms of the Apache Software License and therefore is licensed under ASL v2 or later.

This source code in this repository is free: you can redistribute it and/or modify it under the terms of the Apache Software License version 2, or (at your option) any later version.

This soruce code in this repository is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache Software License for more details.

You should have received a copy of the Apache Software License along with this program. If not, see http://www.apache.org/licenses/LICENSE-2.0.html

The source code forked from other open source projects will inherit its license.

Privacy

This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the Surveillance Platform Disclaimer and Code of Conduct. For more information about CDC's privacy policy, please visit http://www.cdc.gov/privacy.html.

Contributing

Anyone is encouraged to contribute to the repository by forking and submitting a pull request. (If you are new to GitHub, you might start with a basic tutorial.) By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the Apache Software License v2 or later.

All comments, messages, pull requests, and other submissions received through CDC including this GitHub page are subject to the Presidential Records Act and may be archived. Learn more at http://www.cdc.gov/other/privacy.html.

Records

This repository is not a source of government records, but is a copy to increase collaboration and collaborative potential. All government records will be published through the CDC web site.

Notices

Please refer to CDC's Template Repository for more information about contributing to this repository, public domain notices and disclaimers, and code of conduct.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.