Giter VIP home page Giter VIP logo

auspice's Introduction

Build Status NPM version License: AGPL v3

Nextstrain is an open-source project to harness the scientific and public health potential of pathogen genome data. We provide a continually-updated view of publicly available data with powerful analytics and visualizations showing pathogen evolution and epidemic spread. Our goal is to aid epidemiological understanding and improve outbreak response.

Resulting data and inferences are available live at the website nextstrain.org.

We have received a number of generous offers to contribute developer effort to nextstrain (and auspice) following our work on SARS-CoV-2. We are flattered and would welcome contributions! Please see the contributing documentation for more details. A list of potential issues is being actively maintained at https://github.com/orgs/nextstrain/projects/5

Auspice

Definition: Observation by an augur, ie a prophetic sign.

Auspice is an open-source interactive web app for visualizing phylogenomic data. It may be used in tandem with nextstrain's bioinformatics toolkit augur or on its own. Auspice may be used to explore datasets locally or run as a as a server to share results.

Documentation

Please see nextstrain.github.io/auspice for auspice documentation.

Installation

npm install --global auspice

See here for full instructions, including how to install from source.

Quickstart

In order to get up & running you'll need to have some datasets to visualise. Please see the nextstrain docs for tutorials on how to do this. For the purposes of getting started, you can download the current zika dataset via:

mkdir datasets
curl http://data.nextstrain.org/zika.json --compressed -o data/zika.json

And then run auspice via:

auspice view --datasetDir data

This will allow you to run auspice locally (i.e. from your computer) and view the dataset which is behind nextstrain.org/zika.

To download all the datasets at once, the following helper command will populate the /data folder.

  npm run get-data

Run auspice --help or visit nextstrain.github.io/auspice for more information.

Development, comments, issues and bugs

Auspice is developed via GitHub and issues are very welcome. Alternatively, email us with any questions or comments you may have. If you are interested in submitting a pull request please use eslint as much as possible -- thanks!

New versions are released via the ./releaseNewVersion.sh script from an up-to-date master branch. It will prompt you for the version number increase, push changes to the release branch and, as long as Travis-CI is successful then a new version will be automatically published to npm.

Please see docs-src/README for how the auspice documentation site is built.

Note that currently the documentation must be rebuilt & pushed to GitHub after a new version is released in order for the changelog to correctly appear at nextstrain.github.io/auspice/releases/changelog.

License and copyright

Copyright 2014-2019 Trevor Bedford and Richard Neher.

Source code to Nextstrain is made available under the terms of the GNU Affero General Public License (AGPL). Nextstrain 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 GNU Affero General Public License for more details.

auspice's People

Contributors

jameshadfield avatar trvrb avatar colinmegill avatar rneher avatar emmahodcroft avatar kairstenfay avatar tsibley avatar joverlee521 avatar huddlej avatar evogytis avatar ivan-aksamentov avatar lmoncla avatar misjailcisin avatar zachcp avatar artoria2e5 avatar barneypotter24 avatar hydrosquall avatar cassiawag avatar metasoarous avatar matsen avatar felixonmars avatar dnprock avatar neavemj avatar wdingx 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.