,
Maëlle Salmon [aut],
Jacob Wujciak-Jens [aut] | Title: | rOpenSci Package Checks |
|---|---|
| Description: | Check whether a package is ready for submission to rOpenSci's peer review system. |
| Authors: | Mark Padgham [aut, cre] ,
Maëlle Salmon [aut],
Jacob Wujciak-Jens [aut] |
| Maintainer: | Mark Padgham <[email protected]> |
| License: | GPL-3 |
| Version: | 0.1.2.063 |
| Built: | 2024-10-23 13:24:56 UTC |
| Source: | https://github.com/ropensci-review-tools/pkgcheck |
Convert checks to markdown-formatted report
checks_to_markdown(checks, render = FALSE)checks_to_markdown(checks, render = FALSE)
checks |
Result of main pkgcheck function |
render |
If |
Markdown-formatted version of check report
Other extra:
list_pkgchecks(),
logfile_names(),
render_md2html()
## Not run: checks <- pkgcheck ("/path/to/my/package") md <- checks_to_markdown (checks) # markdown-formatted character vector md <- checks_to_markdown (checks, render = TRUE) # HTML version ## End(Not run)## Not run: checks <- pkgcheck ("/path/to/my/package") md <- checks_to_markdown (checks) # markdown-formatted character vector md <- checks_to_markdown (checks, render = TRUE) # HTML version ## End(Not run)
get_default_github_branch
get_default_github_branch(org, repo)get_default_github_branch(org, repo)
org |
Github organization |
repo |
Github repository |
Name of default branch on GitHub
This function is not intended to be called directly, and is only exported to enable it to be used within the plumber API.
Other github:
get_gh_token(),
get_latest_commit(),
use_github_action_pkgcheck()
## Not run: org <- "ropensci-review-tools" repo <- "pkgcheck" branch <- get_default_github_branch (org, repo) ## End(Not run)## Not run: org <- "ropensci-review-tools" repo <- "pkgcheck" branch <- get_default_github_branch (org, repo) ## End(Not run)
Get GitHub token
get_gh_token(token_name = "")get_gh_token(token_name = "")
token_name |
Optional name of token to use |
The value of the GitHub access token extracted from environment variables.
Other github:
get_default_github_branch(),
get_latest_commit(),
use_github_action_pkgcheck()
## Not run: token <- get_gh_token () ## End(Not run)## Not run: token <- get_gh_token () ## End(Not run)
get_latest_commit
get_latest_commit(org, repo, branch = NULL)get_latest_commit(org, repo, branch = NULL)
org |
Github organization |
repo |
Github repository |
branch |
Branch from which to get latest commit |
Details of latest commit including OID hash
This returns the latest commit from the default branch as specified on
GitHub, which will not necessarily be the same as information returned from
gert::git_info if the HEAD of a local repository does not point to the
same default branch.
Other github:
get_default_github_branch(),
get_gh_token(),
use_github_action_pkgcheck()
## Not run: org <- "ropensci-review-tools" repo <- "pkgcheck" commit <- get_latest_commit (org, repo) ## End(Not run)## Not run: org <- "ropensci-review-tools" repo <- "pkgcheck" commit <- get_latest_commit (org, repo) ## End(Not run)
List all checks currently implemented
list_pkgchecks(quiet = FALSE)list_pkgchecks(quiet = FALSE)
quiet |
If |
Character vector of names of all checks (invisibly)
Other extra:
checks_to_markdown(),
logfile_names(),
render_md2html()
list_pkgchecks ()list_pkgchecks ()
r_bg processSet up stdout & stderr cache files for r_bg process
logfile_names(path)logfile_names(path)
path |
Path to local repository |
Vector of two strings holding respective local paths to stdout and
stderr files for r_bg process controlling the main pkgcheck
function when executed in background mode.
These files are needed for the callr r_bg process which
controls the main pkgcheck. The stdout and stderr pipes from the
process are stored in the cache directory so they can be inspected via their
own distinct endpoint calls.
Other extra:
checks_to_markdown(),
list_pkgchecks(),
render_md2html()
## Not run: logfiles <- logfiles_namnes ("/path/to/my/package") print (logfiles) ## End(Not run)## Not run: logfiles <- logfiles_namnes ("/path/to/my/package") print (logfiles) ## End(Not run)
Generate report on package compliance with rOpenSci Statistical Software requirements
pkgcheck( path = ".", goodpractice = TRUE, use_cache = TRUE, extra_env = .GlobalEnv )pkgcheck( path = ".", goodpractice = TRUE, use_cache = TRUE, extra_env = .GlobalEnv )
path |
Path to local repository |
goodpractice |
If |
use_cache |
Checks are cached for rapid retrieval, and only re-run if
the git hash of the local repository changes. Setting |
extra_env |
Additional environments from which to collate checks. Other
package names may be appended using |
A pkgcheck object detailing all package assessments automatically
applied to packages submitted for peer review.
Other pkgcheck_fns:
pkgcheck_bg(),
print.pkgcheck()
## Not run: checks <- pkgcheck ("/path/to/my/package") # default full check summary (checks) # Or to run only checks implemented in 'pkgcheck' and not the # additional \pkg{goodpractice} checks: checks <- pkgcheck ("/path/to/my/package", goodpractice = FALSE) summary (checks) ## End(Not run)## Not run: checks <- pkgcheck ("/path/to/my/package") # default full check summary (checks) # Or to run only checks implemented in 'pkgcheck' and not the # additional \pkg{goodpractice} checks: checks <- pkgcheck ("/path/to/my/package", goodpractice = FALSE) summary (checks) ## End(Not run)
Generate report on package compliance with rOpenSci Statistical Software requirements as background process
pkgcheck_bg(path)pkgcheck_bg(path)
path |
Path to local repository |
A processx object connecting to the background process generating the main pkgcheck results (see Note).
The return object will by default display whether it is still running,
or whether it has finished. Once it has finished, the results can be obtained
by calling $get_result(), or the main pkgcheck function can be
called to quickly retrieve the main results from local cache.
This function does not accept the extra_env parameter of the main
pkgcheck function, and can not be used to run extra, locally-defined
checks.
Other pkgcheck_fns:
pkgcheck(),
print.pkgcheck()
## Not run: # Foreground checks as "blocking" process which will return # only after all checks have finished: checks <- pkgcheck ("/path/to/my/package") # Or run process in background, do other things in the meantime, # and obtain checks once they have finished: ps <- pkgcheck_bg ("/path/to/my/package") ps # print status to screen, same as 'ps$print()' # To examine process state while running: f <- ps$get_output_file () readLines (f) # or directly open file with local file viewer # ... ultimately wait until 'running' changes to 'finished', then: checks <- ps$get_result () ## End(Not run)## Not run: # Foreground checks as "blocking" process which will return # only after all checks have finished: checks <- pkgcheck ("/path/to/my/package") # Or run process in background, do other things in the meantime, # and obtain checks once they have finished: ps <- pkgcheck_bg ("/path/to/my/package") ps # print status to screen, same as 'ps$print()' # To examine process state while running: f <- ps$get_output_file () readLines (f) # or directly open file with local file viewer # ... ultimately wait until 'running' changes to 'finished', then: checks <- ps$get_result () ## End(Not run)
Generic print method for 'pkgcheck' objects.
## S3 method for class 'pkgcheck' print(x, deps = FALSE, ...)## S3 method for class 'pkgcheck' print(x, deps = FALSE, ...)
x |
A 'pkgcheck' object to be printed. |
deps |
If 'TRUE', include details of dependency packages and function usage. |
... |
Further arguments pass to or from other methods (not used here). |
Nothing. Method called purely for side-effect of printing to screen.
Other pkgcheck_fns:
pkgcheck(),
pkgcheck_bg()
## Not run: checks <- pkgcheck ("/path/to/my/package") print (checks) # print full checks, starting with summary summary (checks) # print summary only ## End(Not run)## Not run: checks <- pkgcheck ("/path/to/my/package") print (checks) # print full checks, starting with summary summary (checks) # print summary only ## End(Not run)
A convenience function to automatically open the web page of rOpenSci's "Package Development Guide" in the default browser.
read_pkg_guide(which = c("release", "dev"))read_pkg_guide(which = c("release", "dev"))
which |
Whether to read the released or "dev" development version. |
Nothing. Function called purely for side-effect of opening web page with package guidelines.
## Not run: read_pkg_guide () ## End(Not run)## Not run: read_pkg_guide () ## End(Not run)
render markdown-formatted input into 'html'
render_md2html(md, open = TRUE)render_md2html(md, open = TRUE)
md |
Result of checks_to_markdown function. |
open |
If |
(invisible) Location of .html-formatted version of input.
Other extra:
checks_to_markdown(),
list_pkgchecks(),
logfile_names()
## Not run: checks <- pkgcheck ("/path/to/my/package") # Generate standard markdown-formatted character vector: md <- checks_to_markdown (checks) # Directly generate HTML output: h <- checks_to_markdown (checks, render = TRUE) # HTML version # Or convert markdown-formatted version to HTML: h <- render_md2html (md) ## End(Not run)## Not run: checks <- pkgcheck ("/path/to/my/package") # Generate standard markdown-formatted character vector: md <- checks_to_markdown (checks) # Directly generate HTML output: h <- checks_to_markdown (checks, render = TRUE) # HTML version # Or convert markdown-formatted version to HTML: h <- render_md2html (md) ## End(Not run)
Creates a Github workflow file in dir integrate pkgcheck() into your CI.
use_github_action_pkgcheck( dir = ".github/workflows", overwrite = FALSE, file_name = "pkgcheck.yaml", branch = gert::git_branch(), inputs = NULL )use_github_action_pkgcheck( dir = ".github/workflows", overwrite = FALSE, file_name = "pkgcheck.yaml", branch = gert::git_branch(), inputs = NULL )
dir |
Directory the file is written to. |
overwrite |
Overwrite existing file? |
file_name |
Name of the workflow file. |
branch |
Name of git branch for checks to run; defaults to currently active branch. |
inputs |
Named list of inputs to the
|
For more information on the action and advanced usage visit the action repository.
The path to the new file, invisibly.
Inputs with description and default values. Pass all values as strings, see examples.
inputs:
ref:
description: "The ref to checkout and check. Set to empty string to skip checkout."
default: "${{ github.ref }}"
required: true
post-to-issue:
description: "Should the pkgcheck results be posted as an issue?"
# If you use the 'pull_request' trigger and the PR is from outside the repo
# (e.g. a fork), the job will fail due to permission issues
# if this is set to 'true'. The default will prevent this.
default: ${{ github.event_name != 'pull_request' }}
required: true
issue-title:
description: "Name for the issue containing the pkgcheck results. Will be created or updated."
# This will create a new issue for every branch, set it to something fixed
# to only create one issue that is updated via edits.
default: "pkgcheck results - ${{ github.ref_name }}"
required: true
summary-only:
description: "Only post the check summary to issue. Set to false to get the full results in the issue."
default: true
required: true
append-to-issue:
description: "Should issue results be appended to existing issue, or posted in new issues."
default: true
required: true
Other github:
get_default_github_branch(),
get_gh_token(),
get_latest_commit()
## Not run: use_github_action_pkgcheck (inputs = list (`post-to-issue` = "false")) use_github_action_pkgcheck (branch = "main") ## End(Not run)## Not run: use_github_action_pkgcheck (inputs = list (`post-to-issue` = "false")) use_github_action_pkgcheck (branch = "main") ## End(Not run)