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 - not aware of OS specific code. CI tests will help address this
  • 1.3.1. Function and argument naming - used tidy guide
  • 1.3.2 I use cli package or base R. Use cat 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
  • 1.3.4 Clear documentation on inputs for the 4 user functions so I think it's ok
  • 1.4 styler::style_pkg() and looked at tidy guide
  • 1.5 CITATION files exist
  • 1.6 REAMDE
  • 1.7 Package and functions have manuals, using roxygen2m checked urls
  • 1.8 Lots of optional things, but I think I have the basic pkgdown website
  • 1.9 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.
  • 1.12 A few simple examples added, may be able to improve, it's difficult due to user interaction
  • 1.13 Dependencies in DESCRIPTION and NAMESPACE
  • 1.14 Recommended scaffolding - change to jsonlite
  • 1.15 version control
  • 1.16 misc CRAN gotchas
  • 2 Added CI and code cov GH actions
  • 3 package security - not relevant right now
• Already using the the pkgcheck GitHub Action

Checks to run again after all the changes

pak::pkg_name_check('browseMetadata')
codemetar::write_codemeta()
styler::style_pkg()
devtools::check()