srr_report

Generate report from ssr tags.

Description

Generate report from ssr tags.

Usage

srr_report(path = ".", branch = "", view = TRUE)

Arguments

Argument

Description

path

Path to package for which report is to be generated

branch

By default a report will be generated from the current branch as set on the local git repository; this parameter can be used to specify any alternative branch.

view

If TRUE (default), a html-formatted version of the report is opened in default system browser. If FALSE , the return object includes the name of a html -rendered version of the report in an attribute named ‘file’.

Value

(invisibly) Markdown-formatted lines used to generate the final html document.

Examples

path <- srr_stats_pkg_skeleton ()
srr_report (path)