Skip to content

Commit

Permalink
Rename instances of "monkeypox" to "mpox"
Browse files Browse the repository at this point in the history
This commit goes through the repo and basically does a find-and-replace of "monkeypox" to "mpox, except for a handful of locations like the #monkeypox-updates Slack notification. 

This shouldn't change appearance of build outputs except for:
- Updating to "Built by nextstrain/mpox"
- Updating page titles to be more descriptive of what each page is showing in terms of lineages / clades
- A bug fix to the page description to link to proper build URLs (currently these go to 404)

This has the side effect that intermediate files will begin to propagate to https://data.nextstrain.org/files/workflows/mpox/sequences.fasta.xz, etc... rather than `/files/workflows/monkeypox`. This may affect users who've been relying on the current URLs. Nothing should break for these users as the old files will continue to exist but they will no longer receive updated data. I think this is an okay trade-off in terms of downstream impacts.
  • Loading branch information
trvrb committed Nov 1, 2023
1 parent 9ff822f commit 2726980
Show file tree
Hide file tree
Showing 22 changed files with 47 additions and 47 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/fetch-and-ingest-branch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
run: |
# Create JSON string for the nested upload config
GITHUB_BRANCH=${GITHUB_REF#refs/heads/}
S3_DST="s3://nextstrain-data/files/workflows/monkeypox/branch/${GITHUB_BRANCH}"
S3_DST="s3://nextstrain-data/files/workflows/mpox/branch/${GITHUB_BRANCH}"
UPLOAD_CONFIG=$(jq -cn --arg S3_DST "$S3_DST" '{"s3": {"dst": $S3_DST }}')
echo "upload_config=$UPLOAD_CONFIG" >> "$GITHUB_OUTPUT"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/rebuild-all.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ jobs:
steps:
- uses: actions/checkout@v3
- name: Repository Dispatch
run: ./ingest/vendored/trigger nextstrain/monkeypox rebuild
run: ./ingest/vendored/trigger nextstrain/mpox rebuild
env:
PAT_GITHUB_DISPATCH: ${{ secrets.GH_TOKEN_NEXTSTRAIN_BOT_WORKFLOW_DISPATCH }}
2 changes: 1 addition & 1 deletion .github/workflows/rebuild-hmpxv1-big.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
workflow_dispatch:
inputs:
trial_name:
description: "If set, result will be at nextstrain.org/staging/trial/trial_name/monkeypox/mpxv"
description: "If set, result will be at nextstrain.org/staging/trial/trial_name/mpox/mpxv"
required: false
image:
description: 'Specific container image to use for build (will override the default of "nextstrain build")'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/rebuild-hmpxv1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
workflow_dispatch:
inputs:
trial_name:
description: "If set, result will be at nextstrain.org/staging/trial/trial_name/monkeypox/mpxv"
description: "If set, result will be at nextstrain.org/staging/trial/trial_name/mpox/mpxv"
required: false
image:
description: 'Specific container image to use for build (will override the default of "nextstrain build")'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/rebuild-mpxv.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
workflow_dispatch:
inputs:
trial_name:
description: "If set, result will be at nextstrain.org/staging/trial/trial_name/monkeypox/mpxv"
description: "If set, result will be at nextstrain.org/staging/trial/trial_name/mpox/mpxv"
required: false
image:
description: 'Specific container image to use for build (will override the default of "nextstrain build")'
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Nextstrain repository for mpox virus

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/nextstrain/monkeypox/master.svg)](https://results.pre-commit.ci/latest/github/nextstrain/monkeypox/master)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/nextstrain/mpox/master.svg)](https://results.pre-commit.ci/latest/github/nextstrain/mpox/master)

This repository contains two workflows for the analysis of mpox virus (MPXV) data:

Expand Down
4 changes: 2 additions & 2 deletions ingest/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# nextstrain.org/monkeypox/ingest
# nextstrain.org/mpox/ingest

This is the ingest pipeline for mpox virus sequences.

Expand All @@ -9,7 +9,7 @@ Follow the [standard installation instructions](https://docs.nextstrain.org/en/l
## 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`
> If running commands from the outer `mpox` directory, please replace the `.` with `ingest`
Fetch sequences with

Expand Down
2 changes: 1 addition & 1 deletion ingest/config/optional.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ upload:
# Upload params for AWS S3
s3:
# AWS S3 Bucket with prefix
dst: 's3://nextstrain-data/files/workflows/monkeypox'
dst: 's3://nextstrain-data/files/workflows/mpox'
# Files to upload to S3 that are in the `data` directory
files_to_upload: [
'genbank.ndjson',
Expand Down
6 changes: 3 additions & 3 deletions ingest/vendored/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,14 @@ commit hash if needed.

Much of this tooling originated in
[ncov-ingest](https://github.com/nextstrain/ncov-ingest) and was passaged thru
[monkeypox's ingest/](https://github.com/nextstrain/monkeypox/tree/@/ingest/).
It subsequently proliferated from [monkeypox][] to other pathogen repos
[mpox ingest/](https://github.com/nextstrain/mpox/tree/@/ingest/).
It subsequently proliferated from [mpox][] to other pathogen repos
([rsv][], [zika][], [dengue][], [hepatitisB][], [forecasts-ncov][]) primarily
thru copying. To [counter that
proliferation](https://bedfordlab.slack.com/archives/C7SDVPBLZ/p1688577879947079),
this repo was made.

[monkeypox]: https://github.com/nextstrain/monkeypox
[mpox]: https://github.com/nextstrain/mpox
[rsv]: https://github.com/nextstrain/rsv
[zika]: https://github.com/nextstrain/zika/pull/24
[dengue]: https://github.com/nextstrain/dengue/pull/10
Expand Down
6 changes: 3 additions & 3 deletions ingest/workflow/snakemake_rules/slack_notifications.smk
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ if not slack_envvars_defined:
)
sys.exit(1)

S3_SRC = "s3://nextstrain-data/files/workflows/monkeypox"
S3_SRC = "s3://nextstrain-data/files/workflows/mpox"


rule notify_on_genbank_record_change:
Expand Down Expand Up @@ -48,8 +48,8 @@ rule notify_on_metadata_diff:


onstart:
shell("./vendored/notify-on-job-start Ingest nextstrain/monkeypox")
shell("./vendored/notify-on-job-start Ingest nextstrain/mpox")


onerror:
shell("./vendored/notify-on-job-fail Ingest nextstrain/monkeypox")
shell("./vendored/notify-on-job-fail Ingest nextstrain/mpox")
2 changes: 1 addition & 1 deletion ingest/workflow/snakemake_rules/trigger_rebuild.smk
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ rule trigger_build:
touch("data/trigger/rebuild.done"),
shell:
"""
./vendored/trigger-on-new-data nextstrain/monkeypox rebuild {input.metadata_upload} {input.fasta_upload}
./vendored/trigger-on-new-data nextstrain/mpox rebuild {input.metadata_upload} {input.fasta_upload}
"""
12 changes: 6 additions & 6 deletions phylogenetic/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# nextstrain.org/monkeypox
# nextstrain.org/mpox

This is the [Nextstrain](https://nextstrain.org) build for MPXV (mpox virus). Output from this build is visible at [nextstrain.org/monkeypox](https://nextstrain.org/monkeypox).
This is the [Nextstrain](https://nextstrain.org) build for MPXV (mpox virus). Output from this build is visible at [nextstrain.org/mpox](https://nextstrain.org/mpox).
The lineages within the recent mpox outbreaks in humans are defined in a separate [lineage-designation repository](https://github.com/mpxv-lineages/lineage-designation).

## Software requirements
Expand All @@ -13,8 +13,8 @@ Follow the [standard installation instructions](https://docs.nextstrain.org/en/l

Input sequences and metadata can be retrieved from data.nextstrain.org

* [sequences.fasta.xz](https://data.nextstrain.org/files/workflows/monkeypox/sequences.fasta.xz)
* [metadata.tsv.gz](https://data.nextstrain.org/files/workflows/monkeypox/metadata.tsv.gz)
* [sequences.fasta.xz](https://data.nextstrain.org/files/workflows/mpox/sequences.fasta.xz)
* [metadata.tsv.gz](https://data.nextstrain.org/files/workflows/mpox/metadata.tsv.gz)

Note that these data are generously shared by many labs around the world.
If you analyze and plan to publish using these data, please contact these labs first.
Expand Down Expand Up @@ -47,7 +47,7 @@ nextstrain build . --configfile config/hmpxv1_big/config.yaml

### Deploy

⚠️ The below is outdated and needs to be adjusted for the new build names (mpxv instead of monkeypox, etc.)
⚠️ The below is outdated and needs to be adjusted for the new build names (mpox instead of monkeypox, etc.)

<details>

Expand Down Expand Up @@ -84,7 +84,7 @@ There is little redirection and each rule should be able to be reasoned with on

## Update example data

[Example data](./example_data/) is used by [CI](https://github.com/nextstrain/monkeypox/actions/workflows/ci.yaml). It can also be used as a small subset of real-world data.
[Example data](./example_data/) is used by [CI](https://github.com/nextstrain/mpox/actions/workflows/ci.yaml). It can also be used as a small subset of real-world data.

Example data should be updated every time metadata schema is changed or a new clade/lineage emerges. To update, run:

Expand Down
2 changes: 1 addition & 1 deletion phylogenetic/bin/notify-on-error
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ if [[ -n "$slack_ts_file" ]]; then
elif [[ -n "${AWS_BATCH_JOB_ID}" ]]; then
message+="See AWS Batch job \`${AWS_BATCH_JOB_ID}\` (<https://console.aws.amazon.com/batch/v2/home?region=us-east-1#jobs/detail/${AWS_BATCH_JOB_ID}|link>) for error details."
elif [[ -n "${GITHUB_RUN_ID}" ]]; then
message+="See GitHub Action <https://github.com/nextstrain/monkeypox/actions/runs/${GITHUB_RUN_ID}?check_suite_focus=true|${GITHUB_RUN_ID}> for error details."
message+="See GitHub Action <https://github.com/nextstrain/mpox/actions/runs/${GITHUB_RUN_ID}?check_suite_focus=true|${GITHUB_RUN_ID}> for error details."
fi

"$ingest_vendored"/notify-slack "$message" \
Expand Down
4 changes: 2 additions & 2 deletions phylogenetic/bin/notify-on-start
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ echo "Notifying Slack about starting build."
message="Pipeline starting for the \`$build_name\` build, which will run the phylogenetics and deploy the build."

if [[ -n "${GITHUB_RUN_ID}" ]]; then
message+=" The job was submitted by GitHub Action <https://github.com/nextstrain/monkeypox/actions/runs/${GITHUB_RUN_ID}?check_suite_focus=true|${GITHUB_RUN_ID}>."
message+=" The job was submitted by GitHub Action <https://github.com/nextstrain/mpox/actions/runs/${GITHUB_RUN_ID}?check_suite_focus=true|${GITHUB_RUN_ID}>."
fi

if [[ -n "${AWS_BATCH_JOB_ID}" ]]; then
message+=" The job was launched as AWS Batch job \`${AWS_BATCH_JOB_ID}\` (<https://console.aws.amazon.com/batch/v2/home?region=us-east-1#jobs/detail/${AWS_BATCH_JOB_ID}|link>)."
message+=" Follow along in your local \`monkeypox\` repo with: "'```'"nextstrain build --aws-batch --no-download --attach ${AWS_BATCH_JOB_ID} . "'```'
message+=" Follow along in your local \`mpox\` repo with: "'```'"nextstrain build --aws-batch --no-download --attach ${AWS_BATCH_JOB_ID} . "'```'
fi

"$ingest_vendored"/notify-slack "$message" --output="$slack_response"
Expand Down
22 changes: 11 additions & 11 deletions phylogenetic/config/description.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,31 @@ We gratefully acknowledge the authors, originating and submitting laboratories o

We maintain three views of MPXV evolution:

The first is [`mpox/mpxv-IIb-B.1`] (https://nextstrain.org/mpox/mpxv-IIb-B.1), which focuses on lineage B.1 of the global outbreak that started in 2022 and includes as many sequences as possible. Here, we conduct a molecular clock analysis in which evolutionary rate is estimated from the data (with a resulting estimate of ~6 &times; 10<sup>-5</sup> subs per site per year).
The first is [`mpox/lineage-B.1`](https://nextstrain.org/mpox/lineage-B.1), which focuses on lineage B.1 of the global outbreak that started in 2022 and includes as many sequences as possible. Here, we conduct a molecular clock analysis in which evolutionary rate is estimated from the data (with a resulting estimate of ~6 &times; 10<sup>-5</sup> subs per site per year).

The second is [`mpox/mpxv-IIb`](https://nextstrain.org/mpox/mpxv-IIb), which focuses on recent viruses transmitting from human-to-human and includes viruses belonging to clade IIb. All good quality sequences that are not lineage B.1 are included, while lineage B.1 sequences is heavily subsampled to allow non-B.1 diversity to be studied.Here, we also conduct a molecular clock analysis in which evolutionary rate is estimated from the data (with a resulting estimate of ~6 &times; 10<sup>-5</sup> subs per site per year).
The second is [`mpox/clade-IIb`](https://nextstrain.org/mpox/clade-IIb), which focuses on recent viruses transmitting from human-to-human and includes viruses belonging to clade IIb. All good quality sequences that are not lineage B.1 are included, while lineage B.1 sequences is heavily subsampled to allow non-B.1 diversity to be studied.Here, we also conduct a molecular clock analysis in which evolutionary rate is estimated from the data (with a resulting estimate of ~6 &times; 10<sup>-5</sup> subs per site per year).

The third is [`mpox/mpxv`](https://nextstrain.org/monkeypox/mpxv), which focuses on broader viral diversity and includes viruses from the animal reservoir and previous human outbreaks, encompassing clades I, IIa and IIb as described in [Happi et al](https://virological.org/t/urgent-need-for-a-non-discriminatory-and-non-stigmatizing-nomenclature-for-monkeypox-virus/853) and recently endorsed by a [WHO convened consultation](https://worldhealthorganization.cmail20.com/t/ViewEmail/d/422BD62D623B6A3D2540EF23F30FEDED/F75AF81C90108C72B4B1B1F623478121?alternativeLink=False).
The third is [`mpox/all-clades`](https://nextstrain.org/mpox/all-clades), which focuses on broader viral diversity and includes viruses from the animal reservoir and previous human outbreaks, encompassing clades I, IIa and IIb as described in [Happi et al](https://doi.org/10.1371/journal.pbio.3001769) and endorsed by a [WHO convened consultation](https://worldhealthorganization.cmail20.com/t/ViewEmail/d/422BD62D623B6A3D2540EF23F30FEDED/F75AF81C90108C72B4B1B1F623478121?alternativeLink=False).

#### Analysis
Our bioinformatic processing workflow can be found at [github.com/nextstrain/monkeypox](https://github.com/nextstrain/monkeypox) and includes:
Our bioinformatic processing workflow can be found at [github.com/nextstrain/mpox](https://github.com/nextstrain/mpox) and includes:
- sequence alignment by [nextalign](https://docs.nextstrain.org/projects/nextclade/en/stable/user/nextalign-cli.html)
- masking several regions of the genome, including the first 1350 and last 6422 base pairs and multiple repetitive regions of variable length
- phylogenetic reconstruction using [IQTREE-2](http://www.iqtree.org/)
- ancestral state reconstruction and temporal inference using [TreeTime](https://github.com/neherlab/treetime)
- clade assignment via [clade definitions defined here](https://github.com/nextstrain/monkeypox/blob/master/config/clades.tsv), to label broader MPXV clades I, IIa and IIb and to label hMPXV1 lineages A, A.1, A.1.1, etc...
- clade assignment via [clade definitions defined here](https://github.com/nextstrain/mpox/blob/master/config/clades.tsv), to label broader MPXV clades I, IIa and IIb and to label hMPXV1 lineages A, A.1, A.1.1, etc...

#### Underlying data
We curate sequence data and metadata from the [NCBI Datasets command line tools](https://www.ncbi.nlm.nih.gov/datasets/docs/v2/download-and-install/),
using an NCBI Taxonomy ID defined in [ingest/config/config.yaml](https://github.com/nextstrain/monkeypox/blob/master/ingest/config/config.yaml), as starting point for these analyses.
using an NCBI Taxonomy ID defined in [ingest/config/config.yaml](https://github.com/nextstrain/mpox/blob/master/ingest/config/config.yaml), as starting point for these analyses.
Curated sequences and metadata are available as flat files at:
- [data.nextstrain.org/files/workflows/monkeypox/sequences.fasta.xz](https://data.nextstrain.org/files/workflows/monkeypox/sequences.fasta.xz)
- [data.nextstrain.org/files/workflows/monkeypox/metadata.tsv.gz](https://data.nextstrain.org/files/workflows/monkeypox/metadata.tsv.gz)
- [data.nextstrain.org/files/workflows/mpox/sequences.fasta.xz](https://data.nextstrain.org/files/workflows/mpox/sequences.fasta.xz)
- [data.nextstrain.org/files/workflows/mpox/metadata.tsv.gz](https://data.nextstrain.org/files/workflows/mpox/metadata.tsv.gz)

Pairwise alignments with [Nextclade](https://clades.nextstrain.org/) against the [reference sequence MPXV-M5312_HM12_Rivers](https://www.ncbi.nlm.nih.gov/nuccore/NC_063383), insertions relative to the reference, and translated ORFs are available at
- [data.nextstrain.org/files/workflows/monkeypox/alignment.fasta.xz](https://data.nextstrain.org/files/workflows/monkeypox/alignment.fasta.xz)
- [data.nextstrain.org/files/workflows/monkeypox/insertions.csv.gz](https://data.nextstrain.org/files/workflows/monkeypox/insertions.csv.gz)
- [data.nextstrain.org/files/workflows/monkeypox/translations.zip](https://data.nextstrain.org/files/workflows/monkeypox/translations.zip)
- [data.nextstrain.org/files/workflows/mpox/alignment.fasta.xz](https://data.nextstrain.org/files/workflows/mpox/alignment.fasta.xz)
- [data.nextstrain.org/files/workflows/mpox/insertions.csv.gz](https://data.nextstrain.org/files/workflows/mpox/insertions.csv.gz)
- [data.nextstrain.org/files/workflows/mpox/translations.zip](https://data.nextstrain.org/files/workflows/mpox/translations.zip)

#### Reusing code or images

Expand Down
4 changes: 2 additions & 2 deletions phylogenetic/config/hmpxv1/auspice_config.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"title": "Genomic epidemiology of MPXV",
"title": "Genomic epidemiology of mpox clade IIb viruses",
"maintainers": [
{"name": "Nextstrain team", "url": "http://nextstrain.org"}
],
Expand All @@ -9,7 +9,7 @@
"url": "https://www.ncbi.nlm.nih.gov/genbank/"
}
],
"build_url": "https://github.com/nextstrain/monkeypox",
"build_url": "https://github.com/nextstrain/mpox",
"colorings": [
{
"key": "lineage",
Expand Down
2 changes: 1 addition & 1 deletion phylogenetic/config/hmpxv1/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: "config/description.md"
tree_mask: "config/tree_mask.tsv"

# Use `accession` as the ID column since `strain` currently contains duplicates¹.
# ¹ https://github.com/nextstrain/monkeypox/issues/33
# ¹ https://github.com/nextstrain/mpox/issues/33
strain_id_field: "accession"
display_strain_field: "strain"

Expand Down
4 changes: 2 additions & 2 deletions phylogenetic/config/hmpxv1_big/auspice_config.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"title": "Genomic epidemiology of hMPXV-1 (clade IIb) MPXV using as many sequences as possible",
"title": "Genomic epidemiology of mpox lineage B.1 viruses",
"maintainers": [
{"name": "Nextstrain team", "url": "http://nextstrain.org"}
],
Expand All @@ -9,7 +9,7 @@
"url": "https://www.ncbi.nlm.nih.gov/genbank/"
}
],
"build_url": "https://github.com/nextstrain/monkeypox",
"build_url": "https://github.com/nextstrain/mpox",
"colorings": [
{
"key": "outbreak",
Expand Down
2 changes: 1 addition & 1 deletion phylogenetic/config/hmpxv1_big/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: "config/description.md"
tree_mask: "config/tree_mask.tsv"

# Use `accession` as the ID column since `strain` currently contains duplicates¹.
# ¹ https://github.com/nextstrain/monkeypox/issues/33
# ¹ https://github.com/nextstrain/mpox/issues/33
strain_id_field: "accession"
display_strain_field: "strain"

Expand Down
4 changes: 2 additions & 2 deletions phylogenetic/config/mpxv/auspice_config.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"title": "Genomic epidemiology of MPXV",
"title": "Genomic epidemiology of mpox viruses across clades",
"maintainers": [
{"name": "Nextstrain team", "url": "http://nextstrain.org"}
],
Expand All @@ -9,7 +9,7 @@
"url": "https://www.ncbi.nlm.nih.gov/genbank/"
}
],
"build_url": "https://github.com/nextstrain/monkeypox",
"build_url": "https://github.com/nextstrain/mpox",
"colorings": [
{
"key": "outbreak",
Expand Down
2 changes: 1 addition & 1 deletion phylogenetic/config/mpxv/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ clades: "config/clades.tsv"
tree_mask: "config/tree_mask.tsv"

# Use `accession` as the ID column since `strain` currently contains duplicates¹.
# ¹ https://github.com/nextstrain/monkeypox/issues/33
# ¹ https://github.com/nextstrain/mpox/issues/33
strain_id_field: "accession"
display_strain_field: "strain"

Expand Down
4 changes: 2 additions & 2 deletions phylogenetic/workflow/snakemake_rules/prepare.smk
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ rule download:
sequences="data/sequences.fasta.xz",
metadata="data/metadata.tsv.gz",
params:
sequences_url="https://data.nextstrain.org/files/workflows/monkeypox/sequences.fasta.xz",
metadata_url="https://data.nextstrain.org/files/workflows/monkeypox/metadata.tsv.gz",
sequences_url="https://data.nextstrain.org/files/workflows/mpox/sequences.fasta.xz",
metadata_url="https://data.nextstrain.org/files/workflows/mpox/metadata.tsv.gz",
shell:
"""
curl -fsSL --compressed {params.sequences_url:q} --output {output.sequences}
Expand Down

0 comments on commit 2726980

Please sign in to comment.