Skip to content

Redesign key quantity extraction/insertion pipeline#205

Open
sbreitbart-NOAA wants to merge 2 commits intomainfrom
redesign-kqs
Open

Redesign key quantity extraction/insertion pipeline#205
sbreitbart-NOAA wants to merge 2 commits intomainfrom
redesign-kqs

Conversation

@sbreitbart-NOAA
Copy link
Collaborator

Since we've redesigned the figures and tables to be more flexible on the user's end (i.e., they can more powerfully customize what their plots show by specifying plot arguments), the existing pipeline to extract key quantities and then insert them into the captions/alt text template doesn't work for several quantities anymore. Basically, key quantities need to reflect the users' data summarization, grouping specifications, filtering, etc.

To fix this, I've begun redesigning this pipeline so that key quantities are:

  1. extracted in each plotting function (rather than most at once with write_captions(), and then the remainders with add_more_key_quants())
  2. exported to a csv listing ALL key quantities
  3. inserted into a csv with captions and alt text for figures and tables.

This pipeline should also resolve issues of key quantity calculation dependency, where the calculation of one kq depends on the prior calculation of another. If they're all calculated and stored in a single place, all can be referenced for future calculations of other quantities.

This will also facilitate sharing the kqs with SIS.

Ultimately, write_captions() and add_more_key_quants() should become redundant and removed.

@Schiano-NOAA I've just made a pilot draft focused on plot_landings(), which was a simple example. Could you please take a look and let me know if this is on the right track?

@github-actions
Copy link
Contributor

New version checklist

  • Package version in DESCRIPTION has been updated
  • Release notes have been drafted/published
  • Cheatsheet content has been updated (if applicable)
  • Cheatsheet version has been updated

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