roreviewapi
Plumber API to generate reports on package structure and function for
the @ropensci-review-bot.
The package is not intended for general use, and these documents are
primarily intended for maintainers of this package, although they may
serve as useful templates for similar endeavours. Please contact us if
you have any questions.
Uses functionality provided by the
pkgcheck and
pkgstats
packages. This suite of three packages requires a few system installs,
two for pkgstats
of ctags and GNU
global. Procedures to install
these libraries on various operating systems are described in the
pkgstats package. This package
itself also requires both the GitHub command-line-interface (cli),
gh and
dos2unix.
A local GitHub token also needs to be stored as an environment variable
named GITHUB_TOKEN, and not GITHUB_PAT or anything else; the gh
cli only recognises the former name.
The package also works by locally caching previously analysed packages,
in a pkgcheck subdirectory of the location determined by
rappdirs::user_cache_dir()
You may manually erase the contents of this subdirectory at any time at no risk.
Dockerfile
The server associated with this package can be built by cloning this
repository, and modifying the associated
Dockerfile
by inserting a GitHub token, and associated git config options.
Code of Conduct
Please note that this package is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
Contributors
All contributions to this project are gratefully acknowledged using the allcontributors package following the allcontributors specification. Contributions of any kind are welcome!
Code
mpadge |
maelle |
sckott |
noamross |
Issue Authors
xuanxu |
Issue Contributors
gaborcsardi |
wlandau |
wlandau-lilly |
adamhsparks |
s3alfisc |
Functions
- check_cache
- Check template variables in GitHub issue
- Collate list of checks to single concatenated character string
- Download a GitHub repo to local cache
- Body of main ‘editorcheck’ response
- Get branch from a GitHub URL if non-default branch specified there
- Return sub-directory from URL if present. This function is also intended to
- Check whether a user, identified from GitHub API token, is authorized to call
- Install all system and package dependencies of an R package
- Post review checks to GitHub issue
- Push static
- Check whether README.md features an rOpenSci software-review badge
- Check whether ‘README.md’ has a “peer reviewed” badge
- roreviewapi: Plumber API to report package structure and function
- serve plumber API to report on packages
- Extract final counts of ‘srr’ standards from the report
- Summarise counts of ‘srr’ standards from full ‘srr’ report
- Count number of ‘srr’ statistical standards complied with, and confirm
- Get stats badge grade and standards version for a submission
- Set up stdout & stderr cache files for
- Cross symbol, exported for direct use in plumber API
- Tick symbol, exported for direct use in plumber API
- Check whether a given GitHub URL contains an R package.