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

Add discussion of params.json and defaults to indicator manual #2002

Open
nmdefries opened this issue Jul 25, 2024 · 2 comments
Open

Add discussion of params.json and defaults to indicator manual #2002

nmdefries opened this issue Jul 25, 2024 · 2 comments
Labels
chore documentation Improvements or additions to documentation Engineering Used to filter issues when synching with Asana

Comments

@nmdefries
Copy link
Contributor

Indicator manual

This section should discuss:

  • the local and ansible/production templates
  • params sections
  • standard params that MUST be supported
  • optional standard params
  • how to choose defaults
    • defaults MUST allow production runs to be run every day without updating the params file

We also need to actually design a standard for params.json so that the indicators work more similarly.

@nmdefries
Copy link
Contributor Author

Patch params section should probably always include a flag turning the patching functionality on/off.

@aysim319 aysim319 added Engineering Used to filter issues when synching with Asana chore documentation Improvements or additions to documentation labels Aug 12, 2024
@aysim319
Copy link
Contributor

aysim319 commented Aug 15, 2024

We also don't have any validation for the params.json; Also would be nice to mention read_params() function; currently the function just json.loads from the file;
Context:
https://github.com/cmu-delphi/covidcast-indicators/pull/2000/files#r1709806702

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore documentation Improvements or additions to documentation Engineering Used to filter issues when synching with Asana
Projects
None yet
Development

No branches or pull requests

2 participants