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

Output dataset tag information in json results #1078

Open
ammaraziz opened this issue Dec 21, 2022 · 4 comments
Open

Output dataset tag information in json results #1078

ammaraziz opened this issue Dec 21, 2022 · 4 comments
Labels
t:feat Type: request of a new feature, functionality, enchancement

Comments

@ammaraziz
Copy link

Feature request to output the dataset tag/version used to generate the nextclade output.

Currently, the dataset tag is not captured in the results output (json or tsv). The dataset tag version is useful for tracking what nextclade dataset was used to generate the results. This is especially useful for users like me who use the web platform but also useful for CLI users. The tag version allows me to keep track of how the results were generated as part of QC process.

The json file might be a good place to include the dataset tag version.

@ammaraziz ammaraziz added good first issue Good for newcomers help wanted Extra attention is needed needs triage Mark for review and label assignment t:feat Type: request of a new feature, functionality, enchancement labels Dec 21, 2022
@ivan-aksamentov ivan-aksamentov removed good first issue Good for newcomers help wanted Extra attention is needed needs triage Mark for review and label assignment labels Jan 25, 2023
@ivan-aksamentov
Copy link
Member

@ammaraziz Hi Ammar. How do you imagine it looks like?

Do I just add this information into nextclade.json output? Or do you want a separate file?

Perhaps we could just add ability to download the dataset files in Web, and you would then take the tag.json file from it?

I don't know how to organize it such that it's the most useful for you.

@ammaraziz
Copy link
Author

Hi Ivan,

Looking back at the my suggestion, the web version is fine as it is. On the main page it states the dataset version so i think that's okay.

Where it would be super helpful is to include the dataset version in the json output. If i remember correctly there's a section with metadata.

But anywhere you seem appropriate would be super handy.

@ivan-aksamentov
Copy link
Member

@ammaraziz Just to clarify, there are 2 json outputs. Do you mean nextclade.json (with analysis results) or the tree.json (with Auspice tree)? Or both?

@ammaraziz
Copy link
Author

nextclade.json imo is the best place to put it.

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t:feat Type: request of a new feature, functionality, enchancement
Projects
No open projects
Development

No branches or pull requests

2 participants