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

Package for Easy Interfacing with Repo #82

Open
5 tasks
dgkf opened this issue Apr 8, 2024 · 1 comment
Open
5 tasks

Package for Easy Interfacing with Repo #82

dgkf opened this issue Apr 8, 2024 · 1 comment
Assignees
Labels
theme:repo Repository

Comments

@dgkf
Copy link
Collaborator

dgkf commented Apr 8, 2024

Assuming the r-hub/repos is fruitful, it would be nice to have a few functions for demo'ing a user-friendly interaction with the repo.

  • Similar to the .Rprofile tools mentioned in dgkf/rvalhub-repo-filters-mvp, we could put the filtering criteria as a function into some package to represent a R Validation Hub "best practice".

  • Decide on a package name

  • Modify installed package DESCRIPTION post-installation to include metrics

  • Add PACKAGES file into inst directory

  • Function for specifying filters (maybe defaults for "low", "medium" risk?)
    Ideally, function could look like

    risk_fields()
    # [1] "coverage" "examples_coverage"
    
    # manually specify options
    options(available_package_filters = risk_filter(coverage > 0.5 & examples_coverage > 0.8))
    
    # or use a helper function to update options directly
    add_risk_filter(coverage > 0.5 & examples_coverage > 0.8))
  • A very basic "report" that uses metrics/logs to populate a template

Even if it starts small, I think this will be a good way to share amongst ourselves our own scripts for testing the repo and eventually can house some best practices that might make a process easier to adopt.

I'm open to any and all suggestions for a repo name and am happy to kick one off if someone is interested in taking the lead.

@dgkf dgkf added the theme:repo Repository label Apr 8, 2024
@dgkf dgkf changed the title R Validation Hub Repo Demo Package Package for Easy Interfacing with Repo Apr 8, 2024
@dgkf
Copy link
Collaborator Author

dgkf commented May 9, 2024

Kicked off a repository here: https://github.com/pharmaR/pharmapkgs (permanent name tbd)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
theme:repo Repository
Projects
None yet
Development

No branches or pull requests

2 participants