Prep for rOpenSci submission

[RayStick]

Using this page as ref: https://devguide.ropensci.org/softwarereview_author.html
Copying and pasting relevant actions

6.1 Planning a Submission (or a Pre-Submission Enquiry)

• Do you expect to maintain your package for at least 2 years, or to be able to identify a new maintainer?
• Consult our policies see if your package meets our criteria for fitting into our suite and does not overlap with other packages.
  • Probably data retrieval or data validation and testing for the category?
  • I don't think this package has too much overlap with others, considering how specific it is. Most others related to HDRUK Gateway are APIs that retrieve data?
• Package is at the right maturity stage for review
  • Change project status badge  #139
• README is detailed; pkgdown website exists

6.2 Preparing for Submission

• Read and follow our packaging style guide, reviewer’s guide to ensure your package meets our style and quality criteria.
  • 1.1.1. pak::pkg_name_check('browseMetadata') ✅
  • 1.1.2. codemetar::write_codemeta() ✅
  • 1.2 Only tested on MacOS but I do not see why it would not work on Windows or Linux due to R Studio being similar across these systems? CI tests will help address this?
  • 1.3.1. I have both snake_case and camel case (e.g. mapMetadata_convert_outputs.R) so they may ask to change that but I think I will leave this for now, as there is internal consistency
  • 1.3.2 I use the cli package or base R. Use cat a lot for new lines, and some text printing but I think that's okay.
  • 1.3.2 N/A ? No specific GUI, just user prompts from R console
  • https://devguide.ropensci.org/pkg_building.html#input-checking
  • https://devguide.ropensci.org/pkg_building.html#code-style
  • 1.3.2 CITATION files exist
  • 1.3.2 Check that the new GH Action works: https://docs.ropensci.org/cffr/reference/cff_gha_update.html
  • https://devguide.ropensci.org/pkg_building.html#readme
  • https://devguide.ropensci.org/pkg_building.html#documentation
  • https://devguide.ropensci.org/pkg_building.html#website
  • https://devguide.ropensci.org/pkg_building.html#authorship
  • 1.10 licence ✅
  • 1.10 tests ✅ devtools::check() passes locally
  • 1.10 For testing your functions creating plots, we suggest using vdiffr, an extension of the testthat package that relies on testthat snapshot tests.
  • https://devguide.ropensci.org/pkg_building.html#examples
  • https://devguide.ropensci.org/pkg_building.html#pkgdependencies
  • https://devguide.ropensci.org/pkg_building.html#recommended-scaffolding
  • 1.15 version control ✅
  • https://devguide.ropensci.org/pkg_building.html#crangotchas
  • https://devguide.ropensci.org/pkg_ci.html
  • https://devguide.ropensci.org/pkg_security.html
• All authors are expected to have run the main pkgcheck function locally. Alternatively, use the pkgcheck GitHub Action to run as a GitHub Action, as described in our blog post.

6.3 The Submission Process

• Make a final release (also update Zenodo) - check semantic versions of previous one!
• Submit a GitHub issue via their guide instructions