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

Parameter presets #24

Open
charlesreid1 opened this issue May 18, 2018 · 2 comments
Open

Parameter presets #24

charlesreid1 opened this issue May 18, 2018 · 2 comments
Labels
command-line improvements to the taco command line tool snakemake

Comments

@charlesreid1
Copy link
Member

Multiple ways to do this.

  1. Workflow author provides the user with a ready-to-go sets of parameters labeled (e.g., hard-params.json, medium-params.json, soft-params.json)

  2. User specifies a parameter set on the command line, like % taco workflow1 --medium ...

  3. (not sure how different from 1) in the .settings file of each workflow, the workflow author provides the user with a set of ready to go sets of parameters that are labeled as, e.g., hard_cfg, med_cfg, and soft_cfg that utilize the same mechanism to define a default but would offer multiple defaults.

These approaches all seem to share in common the idea that the workflow author is going to provide a set of defaults. The user can request those defaults in a number of different ways, but we should follow the principles:

  • Keep it simple. Workflow authors have one and only one way to define sets of workflow defaults (am strongly leaning toward 3).
  • Keep it flexible. Let users specify the default sets a number of different ways.
  • Keep it open/friendly. We will need to add functionality to describe default param sets, and to show those descriptions to the user.
@charlesreid1 charlesreid1 added snakemake command-line improvements to the taco command line tool labels May 18, 2018
@charlesreid1
Copy link
Member Author

Leaning more strongly toward item number 1 above (defining default parameter sets in a directory of default parameter sets) rather than item number 3 (

My reasoning is, (I think) we want the default parameter sets to be easy to "discover", duplicate, modify, become a changing component. Putting them into the rules portion of the workflow (which is generally not touched by the user) means they will also not be touched by the user.

(Of course, if that's what we're after - authoritative default parameter set values that the user should not touch - then Option 3 would be better.)


Point of clarification: when I said "Workflow authors have one and only one way to define sets of workflow defaults", I realize this makes it sound like we have to choose from the above options. That's not what I meant - above items cover both the user side and the developer side. We want there to be one way for the developer to specify default parameter sets. We would like to have one or more ways for the user to specify default parameter sets.

@ctb
Copy link

ctb commented May 22, 2018 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
command-line improvements to the taco command line tool snakemake
Projects
None yet
Development

No branches or pull requests

2 participants