pkgreview_getdata: pkgreview_getdata

In annakrystalli/pkgreviewr: rOpenSci package review project template

pkgreview_getdata

Description

get package metadata from package source code.

Usage

pkgreview_getdata(
  pkg_dir = NULL,
  pkg_repo,
  template = c("review", "editor"),
  issue_no = NULL
)

Arguments

pkg_dir	path to package source directory, cloned from github. Defaults to the package source code directory in the review parent.
pkg_repo	character string of the repo owner and name in the form of "owner/repo".
template	character string, one of review or editor.
issue_no	integer. Issue number of the pkg review in the rOpenSci software-review repository. If NULL (default), the issue number is extracted from the rOpenSci Under Review badge on the pkg repository README. Supplying an integer to issue_no overrides this behaviour and can be useful if a badge has not been added to the README yet.

Value

a list of package metadata

Examples

## Not run: 
# run from within a pkgreviewr project with the package source code in a
sibling directory
pkgreview_getdata("../rdflib")

## End(Not run)

annakrystalli/pkgreviewr documentation built on Sept. 12, 2023, 5:35 p.m.