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

Change package name & replace custom functions #170

Merged
merged 13 commits into from
Dec 20, 2024
Merged

Conversation

RayStick
Copy link
Member

@RayStick RayStick commented Dec 20, 2024

So many files have changed because the package has changed from browseMetadata to mapmetadata to

  1. Be more in line with naming best practice
  2. mappping (not browsing) is a better representation of the contribution this package brings

Other changes include:

  • combined the browse function into the map function to simplify package use for the user
  • changed some function names to match object_verb convention
  • moving from json to csv as the the metadata input to reflect the new structure from HDRUK Gateway
  • remove some custom functions, because utils already offered these! (or very similar)
  • update unit tests to match the new code structure
  • update package dependencies to match the new code structure
  • update documentation to match the new code structure and the new naming

Checklist for the author of this PR:

  • [if package files were edited] I have run these checks locally:
    • devtools::document() to generates the .Rd files from any updated roxygen comments.
    • codemetar::write_codemeta() to ensures the metadata file is up to date.
    • styler::style_pkg() to ensure consistent code styling that match the guidelines.
    • devtools::check() for a comprehensive package check. I have resolved any warnings or errors, or written them here in the PR, for discussion.
  • The code base and the documentation files match (they both reflect any recent changes).
  • The title of this PR is clear and self-explantory.
  • I have added any appropriate labels to this PR.
  • This PR is now ready for review (and I have removed the draft PR status).

@github-actions github-actions bot added documentation Improvements or additions to documentation internal Changes related to GH workflows, actions, apps labels Dec 20, 2024
@RayStick RayStick changed the title New input files Change package name & replace custom functions Dec 20, 2024
@RayStick RayStick added the enhancement Feature improvement or addition label Dec 20, 2024
@RayStick RayStick marked this pull request as ready for review December 20, 2024 11:55
@RayStick RayStick merged commit f2e5384 into main Dec 20, 2024
9 checks passed
@RayStick RayStick deleted the new-input-files branch December 20, 2024 12:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement Feature improvement or addition internal Changes related to GH workflows, actions, apps
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant