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

[MRG] add config validation, better input file finding #122

Merged
merged 25 commits into from
Mar 22, 2019

Conversation

bluegenes
Copy link
Member

@bluegenes bluegenes commented Mar 17, 2019

Implement some input/output checks (#110):

A. rule inputs/outputs

  • categorize inputs, outputs from each rule (provide options, e.g. either raw reads or trimmed reads)
  • add a "help" key to params.yml. Use this to print some helpful info about how to use the program/rule (perhaps type of input/output, or workflows that rule is currently in, etc).
  • add "citation" key to params.yml. For future use printing citations of programs used in a workflow.

B. checks for input config files (+ maybe tsv files?):

  • write json schema for the config.yaml that will check formatting. Catch improperly formatted yaml configs and try to be helpful. To do this:
    • script to generate yaml schema for default params for each rule file
    • aggregate these schema for included rules in order to check that input config is correct
    • use snakemake validate to check? Or otherwise validate!
    • modify "required" in schema to match current targets. To do this, generate new full schema as a process in __main__.
  • for samples file (specified in config.yml), check that files can be found:
    • if absolute path, check that
    • else try from path to that yml file
    • else try from os.getcwd()
    • else provide a helpful error!
  • do the above for any file specified?

@bluegenes bluegenes changed the base branch from make_package to master March 21, 2019 22:38
@bluegenes bluegenes changed the title input/output checking [MRG] add config validation, better input file finding Mar 22, 2019
@bluegenes bluegenes merged commit b1b1365 into master Mar 22, 2019
@bluegenes bluegenes deleted the add_input_checks branch March 25, 2019 15:14
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.

1 participant