pkgnet Analysis Report for an R package

Create a standalone HTML report about a package and its networks.

CreatePackageReport(
  pkg_name,
  pkg_reporters = DefaultReporters(),
  pkg_path = NULL,
  report_path = tempfile(pattern = pkg_name, fileext = ".html")
)

Arguments

pkg_name

(string) name of a package

pkg_reporters

(list) a list of package reporters

pkg_path

(string) The path to the package repository. If given, coverage will be calculated for each function. pkg_path can be an absolute or relative path.

report_path

(string) The path and filename of the output report. Default report will be produced in the temporary directory.

Value

an instantiated PackageReport object