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

[Summary Issue] Improve package plots! #159

Open
RayStick opened this issue Dec 6, 2024 · 0 comments
Open

[Summary Issue] Improve package plots! #159

RayStick opened this issue Dec 6, 2024 · 0 comments
Assignees
Labels
enhancement Feature improvement or addition help wanted Extra attention is needed

Comments

@RayStick
Copy link
Member

RayStick commented Dec 6, 2024

Across the package, various updates are needed for the plotting functions. When you are ready to work on one, please convert the bullet points into a separate digestible issues that be addressed across multiple PRs.

I would like to see these changes implemented:

  • Currently the unit tests for test-end_plot.R and test-ref_plot.R are pretty basic. Should consider using snapshot tests! Specifically, the rOpenSci guidance said: For testing your functions creating plots, we suggest using vdiffr, an extension of the testthat package that relies on testthat snapshot tests.
  • Enhancement suggested by @BatoolMM - "Is there any value of enabling the user to customise it, it is created with ggplot - but not sure if there is a function of making it easily customisable by the user or adding it to doc." Consider plotly?
  • Enhancements suggested by @RayStick - Think about what else we could plot in browseMetadata.R that are common features that would be helpful to summarise:
    • display which variables have missing descriptions
    • group variables by datatype
    • group by lookup table? (too similar to the actual mapMetadata.R outputs?)
    • use the DO NOT USE flag etc.
@RayStick RayStick added the enhancement Feature improvement or addition label Dec 6, 2024
@RayStick RayStick added internal Changes related to GH workflows, actions, apps help wanted Extra attention is needed and removed internal Changes related to GH workflows, actions, apps labels Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Feature improvement or addition help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant