Git Product home page Git Product logo

flu-ingest's Introduction

nextstrain.org/monkeypox/ingest

This is the ingest pipeline for Monkeypox virus sequences.

Usage

NOTE: All command examples assume you are within the ingest directory. If running commands from the outer monkeypox directory, please replace the . with ingest

Fetch sequences with

nextstrain build --cpus 1 . data/sequences.ndjson

Run the complete ingest pipeline with

nextstrain build --cpus 1 .

This will produce two files (within the ingest directory):

  • data/metadata.tsv
  • data/sequences.fasta

Run the complete ingest pipeline and upload results to AWS S3 with

nextstrain build . --configfiles config/config.yaml config/optional.yaml

Adding new sequences not from GenBank

Static Files

Do the following to include sequences from static FASTA files.

  1. Convert the FASTA files to NDJSON files with:

    ./ingest/bin/fasta-to-ndjson \
        --fasta {path-to-fasta-file} \
        --fields {fasta-header-field-names} \
        --separator {field-separator-in-header} \
        --exclude {fields-to-exclude-in-output} \
        > ingest/data/{file-name}.ndjson
  2. Add the following to the .gitignore to allow the file to be included in the repo:

    !ingest/data/{file-name}.ndjson
  3. Add the file-name (without the .ndjson extension) as a source to ingest/config/config.yaml. This will tell the ingest pipeline to concatenate the records to the GenBank sequences and run them through the same transform pipeline.

Configuration

Configuration takes place in config/config.yaml by default. Optional configs for uploading files and Slack notifications are in config/optional.yaml.

Environment Variables

The complete ingest pipeline with AWS S3 uploads and Slack notifications uses the following environment variables:

Required

  • AWS_DEFAULT_REGION
  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • SLACK_TOKEN
  • SLACK_CHANNELS

Optional

These are optional environment variables used in our automated pipeline for providing detailed Slack notifications.

Input data

GenBank data

GenBank sequences and metadata are fetched via NCBI Virus. The exact URL used to fetch data is constructed in bin/genbank-url.

flu-ingest's People

Contributors

rneher avatar

Stargazers

 avatar

Watchers

 avatar  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.