get_pages_url: Retrieve pages url for a repo

View source: R/github_handling.R

get_pages_urlR Documentation

Retrieve pages url for a repo

Description

Given an repository on GitHub, retrieve the pages URL for it.

Usage

get_pages_url(repo_name, token = NULL, verbose = FALSE, keep_json = FALSE)

Arguments

repo_name

The full name of the repo to get chapters from. e.g. 'jhudsl/OTTR_Template'

token

If private repositories are to be retrieved, a github personal access token needs to be supplied. Run 'authorize("github")' to set this.

verbose

TRUE/FALSE do you want more progress messages?

keep_json

verbose TRUE/FALSE keep the json file locally?

Value

a data frame with the repository with the following columns: data_level, data_path, chapt_name, url, repository name

Examples

## Not run: 

usethis::create_github_token()

get_pages_url("jhudsl/Documentation_and_Usability")

## End(Not run)

ottrpal documentation built on April 3, 2025, 7:46 p.m.