Function reference • roreviewapi

Main functions

collate_editor_check(): Collate list of checks to single concatenated character string

editor_check(): Body of main 'editorcheck' response

serve_api(): serve plumber API to report on packages

dl_gh_repo(): Download a GitHub repo to local cache

get_branch_from_url(): Get branch from a GitHub URL if non-default branch specified there

post_to_issue(): Post review checks to GitHub issue

Utility functions

check_cache(): check_cache

pkgrep_install_deps(): Install all system and package dependencies of an R package

stdout_stderr_cache(): Set up stdout & stderr cache files for r_bg process

symbol_crs(): Cross symbol, exported for direct use in plumber API

symbol_tck(): Tick symbol, exported for direct use in plumber API

readme_badge(): Check whether README.md features an rOpenSci software-review badge

rOpenSci-specific functions

check_issue_template(): Check template variables in GitHub issue

is_user_authorized(): Check whether a user, identified from GitHub API token, is authorized to call endpoints.

push_to_gh_pages(): Push static html files to gh-pages branch of this repo to serve via GitHub pages.

readme_has_peer_review_badge(): Check whether 'README.md' has a "peer reviewed" badge

srr_counts(): Count number of 'srr' statistical standards complied with, and confirm whether than represents > 50% of all applicable standards.

srr_counts_summary(): Summarise counts of 'srr' standards from full 'srr' report

stats_badge(): Get stats badge grade and standards version for a submission