Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix unintentional defining of multiple datasets #9

Merged
merged 1 commit into from
Jun 24, 2020

Conversation

jameshadfield
Copy link
Member

The original design of nextstrain narratives was that each "section" (paragraph) should define its own dataset, such that a single narrative could display different datasets (or the same one if each section specified the same dataset). This was never implemented -- i.e. in auspice currently only the dataset specified in the YAML frontmatter is ever used -- which has resulted in the inadvertent creation of narratives which specify different (and perhaps invalid) datasets.

Nearly every narrative file in this repo had inadvertently defined multiple datasets! Often this appears to be due to copy&paste of paragraphs from previous narratives etc. Auspice will soon "correctly" interpret these multiple datasets (nextstrain/auspice#1164).

This commit changes 206 narratives which previously specified multiple datasets so that each one now only specifies the dataset defined in the YAML frontmatter. This will preserve the current behavior in future versions of Auspice. The only exception is the "test_multiple-datasets.md" narrative.

There is also a small script which can be run periodically to identify narratives which define multiple narratives.

Closes #8

The original design of nextstrain narratives was that each "section" (paragraph) should define its own dataset, such that a single narrative could display different datasets (or the same one if each section specified the same dataset). This was never implemented -- i.e. in auspice currently only the dataset specified in the YAML frontmatter is ever used -- which has resulted in the inadvertent creation of narratives which specify different (and perhaps invalid) datasets.

Nearly every narrative file in this repo had inadvertently defined multiple datasets! Often this appears to be due to copy&paste of paragraphs from previous narratives etc. Auspice will soon "correctly" interpret these multiple datasets (nextstrain/auspice#1164).

This commit changes 206 narratives which previously specified multiple datasets so that each one now only specifies the dataset defined in the YAML frontmatter. This will preserve the current behavior in future versions of Auspice. The only exception is the "test_multiple-datasets.md" narrative.

There is also a small script which can be run periodically to identify narratives which define multiple narratives.

Closes #8
@cassiawag
Copy link
Contributor

Thanks for pointing this out, James, and fixing all of them. I hadn't realized how rampantly we've defined multiple datasets. I'm tagging @sidneymbell here too, so that she's aware as well.

@jameshadfield jameshadfield merged commit 6a56b0b into master Jun 24, 2020
@jameshadfield jameshadfield deleted the fix-incorrect-dataset-urls branch June 24, 2020 00:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix narratives which inadvertently specify multiple datasets
3 participants