Auspice is run as a command line program --
auspice -- with various subcommands.
You can run each command with
--help attached to see help from the command line.
auspice view --help(this is the main command for interacting with Auspice)
auspice build --help
auspice develop --help
auspice convert --help
How to Get an Example Dataset Up and Running
In order to get up and running you'll need to have some datasets to visualise. For the purposes of getting Auspice up and running you can download the current Zika dataset via:
mkdir datasets curl http://data.nextstrain.org/zika.json --compressed -o datasets/zika.json
And then run
auspice view --datasetDir datasets
This will allow you to run Auspice locally (i.e. from your computer) and view the dataset which is behind nextstrain.org/zika. See below for how to download all of the data available on nextstrain.org.
To analyse your own data, please see the tutorials on the nextstrain docs.
This is the main command we'll run Auspice with, as it makes Auspice available in a web browser for you. There are two common arguments used:
|argument name||data supplied||description|
|datasetDir||PATH||Directory where datasets (JSONs) are sourced. This is ignored if you define custom handlers.|
|narrativeDir||PATH||Directory where narratives (Markdown files) are sourced. This is ignored if you define custom handlers.|
For more complicated setups, where you define your own server handlers, see suppling custom handlers to the Auspice server.
Build the client source code bundle. This is needed in three cases:
- You have installed Auspice from source, or updated the source code.
- You are editing the source code and need to rebuild the client
- You wish to build a customised version of the Auspice client. See Customising Auspice for more info.
Launch Auspice in development mode. This runs a local server and uses hot-reloading to allow automatic updating as you edit the code.
This is only useful if you are editing the client source code!
This is a utility command to convert between dataset formats. Currently, it only converts "Auspice v1" JSONs into "Auspice v2" JSONs, using the same code that is programatically importable.
auspice view will automatically convert "v1" JSONs into "v2" JSONs, so there's no need to do this yourself.
Input File Formats
Auspice is agnostic about the data it visualises -- they don't have to be viral genomes, or real-time, or generated in Augur. (They do, however have to be in a specific file format.)
Auspice takes two different file types: datasets (the tree, map, etc.), which are defined as one or more JSON files and narratives, which are specified as a Markdown file.
For datasets, Auspice (v2.x) can currently load either
- "Auspice v1" JSONs (metadata + tree JSONs) -- see the JSON schemas here and here. The zika dataset we download above is in this format
- "Auspice v2" JSONs. See the JSON schema here.
See the Server API for more details about the file formats an Auspice server (e.g.
auspice view) sends to the client.
We are working on ways to make datasets in Newick / Nexus formats available. You can see an early prototype of this at auspice-us.herokuapp.com where you can drop on Newick (and CSV) files. Using BEAST trees is possible, but you have to use Augur to convert them first.
For narratives, please see Writing a Narrative for a description of the file format.
Obtaining a Set of Input Files
If you'd like to download the datasets and narratives on nextstrain.org then there are two scripts which allow you to do this:
- You can download the dataset JSONs by running this script which will create a
./datadirectory for you.
- You can download the narrative Markdown files by running this script which will create a
./narrativesdirectory for you.
You can then run
auspice view --datasetDir data --narrativeDir narratives to visualise all of the nextstrain.org datasets locally.