Initialise pkgreview
pkgreview_init(pkg_repo, review_dir = ".", pkg_dir = NULL, template = c("review", "editor"), issue_no = NULL)
pkg_repo | character string of the repo owner and name in the form of
|
---|---|
review_dir | path to the review directory. Defaults to the working directory. |
pkg_dir | path to package source directory, cloned from github. Defaults to the package source code directory in the review parent. |
template | character string, one of |
issue_no | integer. Issue number of the pkg review in the rOpenSci software-review repository.
If |
Initialisation creates pre-populated index.Rmd
, pkgreview.md
and README.md
documents.
To initialise correctly, the function requires that the source code for the
package has been cloned. This might need to be done manually if it failed
during review creation. If setup is correct.
# NOT RUN { # run from within an uninitialised pkgreviewr project pkgreview_init(pkg_repo = "ropensci/rdflib") # }