Plumber API to report package structure and function


[Up] [Top]

Documentation for package ‘roreviewapi’ version 0.2.1.049

Help Pages

check_cache check_cache
check_issue_template Check template variables in GitHub issue
collate_editor_check Collate list of checks to single concatenated character string
cran_to_list Convert names of CRAN packages to markdown-formatted list.
deactivate_search Deactivate a volunteer search and delete all associated data
deactivate_stale_searches Auto-deactivate and delete stale volunteer searches
dl_gh_repo Download a GitHub repo to local cache
editor_check Body of main 'editorcheck' response
get_branch_from_url Get branch from a GitHub URL if non-default branch specified there
get_subdir_from_url Return sub-directory from URL if present. This function is also intended to test whether packages are in sub-directories (issue #64)
handle_click Handle a volunteer link click
issue_is_stats Determine whether a GitHub issue is a Stats submission
is_user_authorized Check whether a user, identified from GitHub API token, is authorized to call endpoints.
list_searches List all volunteer searches with recipient and click counts
pkgmatch_repo Body of main 'pkgmatch' response
pkgrep_install_deps Install all system and package dependencies of an R package
post_to_issue Post review checks to GitHub issue
push_to_gh_pages Push static 'html' files to 'gh-pages' branch of this repo to serve via GitHub pages.
readme_badge Check whether README.md features an rOpenSci software-review badge
readme_has_peer_review_badge Check whether 'README.md' has a "peer reviewed" badge
ros_to_list Convert names of rOpenSci packages to markdown-formatted list.
send_search Send a batch of editor search emails
serve_api serve plumber API to report on packages
srr_counts Count number of 'srr' statistical standards complied with, and confirm whether than represents > 50% of all applicable standards.
srr_counts_from_report Extract final counts of 'srr' standards from the report
srr_counts_summary Summarise counts of 'srr' standards from full 'srr' report
stats_badge Get stats badge grade and standards version for a submission
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
url_is_r_pkg Check whether a given GitHub URL contains an R package.