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

Record all parameter values (including defaults) in output MMIF #84

Closed
owencking opened this issue Mar 8, 2024 · 2 comments
Closed
Labels
✨N New feature or request ✌️2 This issue or pull request already exists

Comments

@owencking
Copy link
Collaborator

New Feature Summary

Desired functionality:
When the SWT app is run, the values of all parameters, including those implicitly assigned default values, are recorded in
views > n > metadata > parameters

In v4.1 (and previous versions), parameters are recorded in the MMIF only if they were set explicitly at runtime.

Since different versions of the same app can have different default values for the parameters, having all the parameter values explicitly recorded in the MMIF makes it easier to investigate how a particular MMIF file was generated.

Related

No response

Alternatives

No response

Additional context

This seems to me like desirable functionality to have in all CLAMS apps, not only SWT.

@owencking owencking added the ✨N New feature or request label Mar 8, 2024
@clams-bot clams-bot added this to apps Mar 8, 2024
@github-project-automation github-project-automation bot moved this to Todo in apps Mar 8, 2024
@keighrim
Copy link
Member

keighrim commented Mar 8, 2024

This was actually discussed in clamsproject/mmif#208, then reverted via clamsproject/mmif#216. We can always revisit our previous decision, but a couple things to note;

  1. we can't (re-)use view::metadata::parameters for this, as we want to keep that field for pure user inputs (for reproducibility and accountability)
  2. which leads to an addition of a new field, that will lead to a "breaking" change in MMIF json scheme and will end up with MMIF 1.1.x.

@keighrim
Copy link
Member

Closing as duplicate to clamsproject/mmif#208 , as that issue is now re-opened for further discussion.

@keighrim keighrim closed this as not planned Won't fix, can't repro, duplicate, stale Mar 18, 2024
@github-project-automation github-project-automation bot moved this from Todo to Done in apps Mar 18, 2024
@keighrim keighrim added the ✌️2 This issue or pull request already exists label Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨N New feature or request ✌️2 This issue or pull request already exists
Projects
Archived in project
Development

No branches or pull requests

2 participants