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

Write out the data for a deciles chart #18

Closed
ccunningham101 opened this issue Apr 10, 2022 · 2 comments · Fixed by #28
Closed

Write out the data for a deciles chart #18

ccunningham101 opened this issue Apr 10, 2022 · 2 comments · Fixed by #28
Assignees
Labels
enhancement New feature or request

Comments

@ccunningham101
Copy link

Instead of (or in addition to) outputting a decile chart image, the action could output the deciles table (the first step of decile chart generation). This could allow for the following:

  1. Help address Cannot always reconstruct denominator and group_by parameters #17
  2. Allow for redaction and output checking to happen on the relevant data table
  3. Offline and off-server plotting that could occur without the output checking loop (following Will's workflow)

The action could use a flag to determine whether to return data, graphics, or both

@iaindillingham iaindillingham moved this to Todo in Overview Apr 21, 2022
@iaindillingham iaindillingham self-assigned this Apr 21, 2022
@iaindillingham iaindillingham added the enhancement New feature or request label Apr 21, 2022
@iaindillingham iaindillingham moved this from Todo to In Progress in Overview Apr 21, 2022
@iaindillingham
Copy link
Member

Do you have any thoughts about configuration, @ccunningham101? #24 added the mechanism for reading JSON-encoded configuration. I feel we should use this (i.e. config), rather than arguments (e.g. --input-files), to specify whether we'd like deciles-charts to write tables, charts, or tables and charts. This is because I feel JSON-encoded configuration is for optional things, whereas arguments are for required things. How does the following look, to you:

generate_deciles_charts:
  run: >
    python:latest analysis/deciles_charts.py
      --input-files output/measure_*.csv
      --output-dir output
  config:
    output:
      - tables
      - charts
  needs: [generate_measures]
  outputs:
    moderately_sensitive:
      tables: output/deciles_table_*.csv
      charts: output/deciles_chart_*.png

I envisage that we'll add configuration and, eventually, decide to refactor how the config key looks. However, it would be good to keep existing configuration in mind when adding new configuration. Existing configuration is described in README.md.

@ccunningham101
Copy link
Author

The specification above looks good to me!
I like the split of required params as arguments and options parameters with defaults in the config

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
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants