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

Restore description #184

Merged
merged 4 commits into from
Oct 14, 2024
Merged

Restore description #184

merged 4 commits into from
Oct 14, 2024

Conversation

joverlee521
Copy link
Contributor

@joverlee521 joverlee521 commented Oct 14, 2024

Description of proposed changes

Restore use of the --description option for augur export v2, which was lost during the major refactoring of the workflow in #76.

Allows for build specific descriptions, similar to the auspice_config based on array_builds.smk. If a build specific description is not provided, then defaults to the workflow's config/description.md.

Related issue(s)

Resolves #182

Checklist

  • Checks pass
  • description included in the CI workflow builds

joverlee521 and others added 3 commits October 14, 2024 12:35
Restore use of the `--description` option for `augur export v2`, which
was lost during the major refactoring of the workflow in
<#76>

Allows for build specific descriptions, similar to the `auspice_config`
based on array_builds.smk.¹ If a build specific description is not
provided, then defaults to the workflow's `config/description.md`.

¹ <https://github.com/nextstrain/seasonal-flu/blob/b0ff43d8ccce7e28bf81350eaf8642c79908232f/workflow/snakemake_rules/array_builds.smk#L66-L67>
Copy link
Contributor

@huddlej huddlej left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for picking this up, @joverlee521. This looked good to me locally. I added a commit to pull in the same change for nextflu-private builds and made a couple of suggestions for the updated description.

config/description.md Outdated Show resolved Hide resolved
config/description.md Outdated Show resolved Hide resolved
Remove section on forecasts and refer to "Acknowledgements" option.

Co-authored-by: John Huddleston <[email protected]>
@joverlee521
Copy link
Contributor Author

Thanks for catching those changes @huddlej! Merging now and expecting this to be run with this week's updates.

@joverlee521 joverlee521 merged commit 208a603 into master Oct 14, 2024
3 checks passed
@joverlee521 joverlee521 deleted the fix-description branch October 14, 2024 20:08
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.

Missing description (in auspice footer)
2 participants