covrpage_snapshot: Run covrpage on a GitHub Repository

In yonicd/covrpage: Create a Readme Summary Page for GitHub testthat and covr Outputs

Run covrpage on a GitHub Repository

Description

Runs a covrpage on a GitHub repository in a sterile environment

Usage

covrpage_snapshot(
  repo,
  branch = NULL,
  PAT = Sys.getenv("GITHUB_PAT"),
  host = "api.github.com",
  preview = TRUE
)

Arguments

repo	character, Public GitHub repository
branch	character, Name of the branch to checkout. Default: NULL
PAT	character, GitHub Personal Access Token, Default: Sys.getenv("GITHUB_PAT")
host	character, GitHub API host to use, Default: "api.github.com"
preview	boolean, to open the output in viewer, Default: TRUE

Details

Creates a markdown output that is sent to the internal viewer.

Setting branch to NULL means that clone will use the remote's default branch.

See Also

covrpage clone install_github

Other invoke: covrpage_ci(), covrpage()

Examples

## Not run: 
if(interactive()){
 covrpage_snapshot('tidyverse/purrr')
 }

## End(Not run)

yonicd/covrpage documentation built on Feb. 23, 2023, 6:58 p.m.