Package: roreviewapi 0.2.1.012

Mark Padgham

roreviewapi: Plumber API to report package structure and function

Plumber API to report package structure and function.

Authors:Mark Padgham [aut, cre]

roreviewapi_0.2.1.012.tar.gz
roreviewapi_0.2.1.012.zip(r-4.7)roreviewapi_0.2.1.012.zip(r-4.6)roreviewapi_0.2.1.012.zip(r-4.5)
roreviewapi_0.2.1.012.tgz(r-4.6-any)roreviewapi_0.2.1.012.tgz(r-4.5-any)
roreviewapi_0.2.1.012.tar.gz(r-4.7-any)roreviewapi_0.2.1.012.tar.gz(r-4.6-any)
roreviewapi_0.2.1.012.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
roreviewapi/json (API)

# Install 'roreviewapi' in R:
install.packages('roreviewapi', repos = c('https://packages.ropensci.org', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/ropensci-review-tools/roreviewapi/issues

Pkgdown/docs site:https://docs.ropensci.org

On CRAN:

Conda:

5.36 score 3 stars 30 exports 124 dependencies

Last updated from:f98e946af6 (on main). Checks:10 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK211
pkgdown docsOK202
source / vignettesOK267
linux-release-x86_64OK205
macos-release-arm64OK107
macos-oldrel-arm64OK202
windows-develOK303
windows-releaseOK257
windows-oldrelOK286
wasm-releaseOK176

Exports:check_cachecheck_issue_templatecollate_editor_checkcran_to_listdeactivate_searchdl_gh_repoeditor_checkget_branch_from_urlget_subdir_from_urlhandle_clickis_user_authorizedissue_is_statslist_searchespkgmatch_repopkgrep_install_depspost_to_issuepush_to_gh_pagesreadme_badgereadme_has_peer_review_badgeros_to_listsend_searchserve_apisrr_countssrr_counts_from_reportsrr_counts_summarystats_badgestdout_stderr_cachesymbol_crssymbol_tckurl_is_r_pkg

Dependencies:airtableraskpassbackportsbase64encBiocManagerbitbit64blobbrewbriobslibcachemcallrcheckmateclicliprcodetoolscommonmarkcovrcpp11crayoncredentialscrulcurlcyclocompDBIdescdigestdplyrevaluatefastmapfontawesomefsgenericsgertghqlgitcredsgluegoodpracticegraphqlherehighrhmshtmltoolshttpcodehttpuvhttrhttr2hunspelligraphinijquerylibjsonliteknitrlaterlatticelifecyclelintrloggermagrittrMatrixmemoisemimeopensslotelpakpillarpkgbuildpkgcheckpkgconfigpkgloadpkgstatsplumberpraiseprettyunitsprocessxprogresspromisespsR6rappdirsrcmdcheckRcppreadrremotesrexrlangrmarkdownroxygen2rprojrootRSQLiterstudioapirvestsassselectrsessioninfosodiumspellingsrrstringiswaggersystibbletictoctidyselecttinytextreesittertreesitter.rtriebeardtzdburlcheckerurltoolsutf8vctrsvroomwebutilswhoamiwithrxfunxml2xmlparsedataxopenyamlzip

Debugging the package check API
Debugging Procedure | Check that the API is online | Check log of recent requests | Check installation of system dependencies | Check system output and error logs | Manually running checks
Rendered fromdebugging.Rmdusingknitr::rmarkdown

Last update: 2026-06-29
Started: 2021-10-12

Admin Setup
Prerequisites | Environment variables | Postmark | AirTable | Droplet preparation | DNS | TLS certificate | Troubleshooting: HTTP-01 challenge failed | Deployment | Editor search endpoints | GET /send_search | GET /click/ | GET /list_searches | GET /deactivate_search | Notify email cache
Rendered fromadmin-setup.Rmdusingknitr::rmarkdown

Last update: 2026-05-07
Started: 2026-04-24

API Endpoints
1. editorcheck | 2. editorcheck_contents | 3. pkgmatch | 4. mean | 5. stats_badge | 6. log | 7. clear_cache | 8. stdlogs
Rendered fromendpoints.Rmdusingknitr::rmarkdown

Last update: 2026-03-23
Started: 2021-09-27

Readme and manuals

Help Manual

Help pageTopics
check_cachecheck_cache
Check template variables in GitHub issuecheck_issue_template
Collate list of checks to single concatenated character stringcollate_editor_check
Convert names of CRAN packages to markdown-formatted list.cran_to_list
Deactivate a volunteer search and delete all associated datadeactivate_search
Download a GitHub repo to local cachedl_gh_repo
Body of main 'editorcheck' responseeditor_check
Get branch from a GitHub URL if non-default branch specified thereget_branch_from_url
Return sub-directory from URL if present. This function is also intended to test whether packages are in sub-directories (issue #64)get_subdir_from_url
Handle a volunteer link clickhandle_click
Check whether a user, identified from GitHub API token, is authorized to call endpoints.is_user_authorized
Determine whether a GitHub issue is a Stats submissionissue_is_stats
List all volunteer searches with recipient and click countslist_searches
Body of main 'pkgmatch' responsepkgmatch_repo
Install all system and package dependencies of an R packagepkgrep_install_deps
Post review checks to GitHub issuepost_to_issue
Push static 'html' files to 'gh-pages' branch of this repo to serve via GitHub pages.push_to_gh_pages
Check whether README.md features an rOpenSci software-review badgereadme_badge
Check whether 'README.md' has a "peer reviewed" badgereadme_has_peer_review_badge
Convert names of rOpenSci packages to markdown-formatted list.ros_to_list
Send a batch of editor search emailssend_search
serve plumber API to report on packagesserve_api
Count number of 'srr' statistical standards complied with, and confirm whether than represents > 50% of all applicable standards.srr_counts
Extract final counts of 'srr' standards from the reportsrr_counts_from_report
Summarise counts of 'srr' standards from full 'srr' reportsrr_counts_summary
Get stats badge grade and standards version for a submissionstats_badge
Set up stdout & stderr cache files for 'r_bg' processstdout_stderr_cache
Cross symbol, exported for direct use in plumber APIsymbol_crs
Tick symbol, exported for direct use in plumber APIsymbol_tck
Check whether a given GitHub URL contains an R package.url_is_r_pkg