get_repo_info {ottrpal} | R Documentation |
Retrieve information about a github repo
Description
Given an repository on GitHub, retrieve the information about it from the GitHub API and read it into R.
Usage
get_repo_info(repo_name, token = NULL, verbose = FALSE)
Arguments
repo_name |
The full name of the repo to get bookdown chapters from. e.g. "jhudsl/OTTR_Template" |
token |
If private repositories are to be retrieved, a github personal access token needs to be supplied. If none is supplied, then this will attempt to grab from a git pat set in the environment with usethis::create_github_token(). |
verbose |
TRUE/FALSE do you want more progress messages? |
Value
a data frame with the repository with the following columns: data_level, data_path, chapt_name, url, repository name
Examples
## Not run:
repo_info <- get_repo_info("jhudsl/Documentation_and_Usability")
## End(Not run)
[Package ottrpal version 2.0.0 Index]