Skip to content

Commit

Permalink
Merge pull request #78 from nextstrain/update-docs
Browse files Browse the repository at this point in the history
phylogenetic/nextclade: Add links to tutorials and zika/mpox repos
  • Loading branch information
joverlee521 authored Dec 9, 2024
2 parents aa3dd48 + 1bde98e commit a443038
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
8 changes: 8 additions & 0 deletions nextclade/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ The new standard would be to include the Nextclade workflow within the pathogen
This workflow is used to create the Nextclade datasets for this pathogen.
All official Nextclade datasets are available at https://github.com/nextstrain/nextclade_data.

> [!IMPORTANT]
> We do not have a generalized nextclade workflow so the rules files are empty and
> will need to be filled in with your own rules. We suggest that you go through the
> [Nextclade dataset creation guide](https://github.com/nextstrain/nextclade_data/blob/@/docs/dataset-creation-guide.md)
> to understand how to create a Nextclade dataset from scratch. Then use
> [mpox](https://github.com/nextstrain/mpox) as an example to create your own
> Nextclade workflow.
## Workflow Usage

The workflow can be run from the top level pathogen repo directory:
Expand Down
8 changes: 8 additions & 0 deletions phylogenetic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
This workflow uses metadata and sequences to produce one or multiple [Nextstrain datasets][]
that can be visualized in Auspice.

> [!IMPORTANT]
> We do not have a generalized phylogenetic workflow so the rules files are empty and
> will need to be filled in with your own rules. We suggest that you go through the
> ["Creating a phylogenetic workflow" tutorial](https://docs.nextstrain.org/en/latest/tutorials/creating-a-phylogenetic-workflow.html)
> to understand the simplified zika-tutorial workflow. Then use [zika](https://github.com/nextstrain/zika)
> and [mpox](https://github.com/nextstrain/mpox) as examples to create
> your own phylogenetic workflow.
## Workflow Usage

The workflow can be run from the top level pathogen repo directory:
Expand Down

0 comments on commit a443038

Please sign in to comment.