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

Update provenance format #27

Merged
merged 19 commits into from
Feb 8, 2024
Merged

Update provenance format #27

merged 19 commits into from
Feb 8, 2024

Conversation

taranewman
Copy link
Member

@taranewman taranewman commented Feb 7, 2024

Fixes #20

Adding provenance in the same format as BCCDC-PHL/kma-cgmlst

Format may still be adjusted to add name and and flag and optional description variable.

TBD: BCCDC-PHL/pipeline-provenance-schema

@taranewman taranewman changed the title Update provenance Update provenance format Feb 7, 2024
@taranewman taranewman requested a review from dfornika February 7, 2024 16:54
@dfornika
Copy link
Member

dfornika commented Feb 7, 2024

This is looking great. Could you add a section to the README that describes the format of the provenance file? See the kma-cgmlst README for an example. Please be sure not to include any real sample IDs in the example (just replace with sample-01 or similar)

https://github.com/BCCDC-PHL/kma-cgmlst?tab=readme-ov-file#provenance

printf -- "- process_name: tbprofiler\\n" > ${sample_id}_tbprofiler_provenance.yml
printf -- " tools:\\n" >> ${sample_id}_tbprofiler_provenance.yml
printf -- " - tool_name: tb-profiler\\n" >> ${sample_id}_tbprofiler_provenance.yml
printf -- " database_version: \$(grep 'Database version' ${sample_id}_tbprofiler_full_report.csv | cut -d',' -f2)\\n" >> ${sample_id}_tbprofiler_provenance.yml
Copy link
Member

Choose a reason for hiding this comment

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

Can we remove this database_version attribute here? That's important provenance info but I think we may need to find another place to put it. It doesn't fit there in the schema.

Copy link
Member

Choose a reason for hiding this comment

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

...nevermind, I've done it myself.

@dfornika dfornika merged commit e1156b4 into main Feb 8, 2024
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.

Update provenance format
2 participants