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

Heads up for when you update Nextclade to v1.10.0 #35

Closed
corneliusroemer opened this issue Jan 25, 2022 · 3 comments
Closed

Heads up for when you update Nextclade to v1.10.0 #35

corneliusroemer opened this issue Jan 25, 2022 · 3 comments
Assignees
Labels
bug Something isn't working

Comments

@corneliusroemer
Copy link
Contributor

I wanted to give you a small heads up. I found your repo through a quick code search, because it doesn't use --input-dataset for Nextclade run. Thus if you update to v1.10.0 (it was released yesterday), you will have to add a line. We recommend to use --input-dataset, but you can also add --input-virus-properties excplicitly.

See this issue for a detailed explanation: nextstrain/nextclade#703

You need to make a change like here: broadinstitute/viral-pipelines@97fd339

Sorry for the trouble.

@mattdmem
Copy link
Contributor

Thank you for the heads up - we will update our code!

@mattdmem mattdmem self-assigned this Jan 26, 2022
@mattdmem mattdmem added the bug Something isn't working label Jan 26, 2022
@corneliusroemer
Copy link
Contributor Author

Patch version 1.10.1 comes with a more helpful error message in this use case.

https://github.com/nextstrain/nextclade/releases/tag/1.10.1

Here are notes that should help migrating:

Nextclade CLI 1.10.1 (2022-01-26)

[Fix] Improve error message when the virus properties file is missing #704

Since version 1.10.0 Nextclade CLI have introduced a new required input file, virus_properties.json and datasets and documentation were updated to match. However, users who don't use datasets might have encountered breakage due to a missing file: when running Nextclade CLI without either --input-dataset of --input-virus-properties flag provided, it would stop with an unclear error message. In this release we improve the error message, making sure that that explains the problem and offers a solution.

This does not affect Nextclade Web or Nextalign CLI.

In order to facilitate upgrades, for most users, we recommend to:

  • download the latest dataset before each Nextclade CLI session (e.g. in the beginning of an automated workflow, or once you start a batch of experiments manually) using nextclade dataset get command
  • use --input-dataset flag instead of individual --input-* flags for dataset files when issuing nextclade run command
  • if necessary, override some of the individual input files using corresponding --input-* flags

[Fix] Add information about virus_properties.json or --input-virus-properties to changelog

In the excitement of bringing the new features, we forgot to mention virus_properties.json or --input-virus-properties in the changelog when Nextclade CLI 1.10.0 was released. We now added this information retroactively.

@mattdmem
Copy link
Contributor

mattdmem commented Feb 4, 2022

Fixed in an upcoming release.

@mattdmem mattdmem closed this as completed Feb 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Development

No branches or pull requests

2 participants