Record command-line in BCO and WRROC files - #60
Open
suhrig wants to merge 2 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Following up on my question in #58, this PR introduces an optional configuration flag,
recordCommandLine, for both the BCO and WRROC provenance output formats. By default, it is off, ensuring the exact same behavior of the plugin as usual. When enabled, the plugin records the exact command-line invocation used to launch the Nextflow workflow in the generated provenance metadata.Configuration example:
The command-line is recorded in the
usability_domainof the BCO object. The IEEE-2791 schema specifiesusability_domainas a list of free-text strings intended to guide users on how to understand, execute, or reproduce the computational object. Placing the launch command here provides clear, human-readable execution context without violating strict schema constraints.The WRROC object records the info in the
descriptionof the mainCreateAction. This is where the specification explicitly recommends putting details on the execution of the pipeline.Let me know what you think about this suggestion.