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

Config schema #8

Open
brynpickering opened this issue Oct 29, 2020 · 0 comments
Open

Config schema #8

brynpickering opened this issue Oct 29, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@brynpickering
Copy link
Member

We can validate our config using a JSON Schema (see the Snakemake docs), which would help to manage what a user is able to define.

As well as listing configurable options, we can set which ones are required and which are optional (with defaults) and limit the configuration data type and set of possible entries. Already mentioned in #7 is the need to limit the NUTS years that can be defined.

Others I see are:

  1. Countries, they must be within the European continent
  2. Bounds, they must make sense as coordinates
  3. Administrative units, must be in [nuts0, nuts1, gadm0, lau2, etc.]
  4. Floats in parameters must be positive, and some have more stringent ranges
@timtroendle timtroendle added the enhancement New feature or request label Nov 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants