-
Notifications
You must be signed in to change notification settings - Fork 20
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
view: Allow user to specify narratives directory #128
Comments
Ah, good catch! I think the best way to solve this ends up being pretty simple: add
I prefer to keep options to a minimum, and since there's an alternate solution which doesn't require another user option, I'd prefer that.
I prefer even more to avoid this sort of pass thru of arguments when possible, as it can be hard to explain to users who aren't familiar with the concept and it can make it harder to change the interface in the future because pass thru breaks the encapsulation otherwise provided. |
Previously the launched Auspice would either show baked in test narratives or no narratives at all, depending on the Auspice version. Resolves #128.
I've implemented this in #129. |
Previously the launched Auspice would either show baked in test narratives or no narratives at all, depending on the Auspice version. Resolves #128.
Problems with the solution in #129 led to a different solution which I think is better:
This is backwards incompatible, but only if you have some datasets in a directory which also has an At the same time, it supports an arbitrary directory containing a pile of dataset and/or narrative files (except for the narrow case of also containing an |
Previously the launched Auspice would either show baked in test narratives or no narratives at all, depending on the Auspice version. Wee bit of an oversight. orz Resolves #128.
Context
The
nextstrain view
command is our recommended solution for users to view their Auspice JSONs. Its current interface accepts a single directory that should contain Auspice JSON files to view. The correspondingauspice view
command provides a--datasetDir
argument that implements the same functionality.However,
auspice view
also provides an argument,--narrativeDir
, that allows users to specify a directory that contains narratives in Markdown format. Thenextstrain view
command does not provide a way for users to view their narratives.Description
Provide a way for users to specify a narratives directory, to mirror the functionality provided by Auspice.
Possible solutions
--narrative-dir
argument tonextstrain view
that passes its value through toauspice view --narrativeDir
auspice
the same waynextstrain build
passes arguments through to SnakemakeThe text was updated successfully, but these errors were encountered: