Retrieve all bookdown chapters for an org — retrieve_org

Given an organization on GitHub, retrieve all the bookdown chapter information for all the Github pages that exist for all the repositories. Currently only public repositories are supported.

Usage,

retrieve_org_chapters(
  org_name = NULL,
  output_file = "org_chapter_info.tsv",
  git_pat = NULL,
  retrieve_learning_obj = FALSE,
  retrieve_keywords = TRUE,
  verbose = TRUE
)

Arguments

org_name: the name of the organization that e.g. "jhudsl"
output_file: a file path for where the chapter information should be saved e.g. "jhudsl_chapter.tsv"
git_pat: 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().
retrieve_learning_obj: TRUE/FALSE attempt to retrieve learning objectives?
retrieve_keywords: TRUE/FALSE attempt to retrieve keywords from the chapter?
verbose: TRUE/FALSE do you want more progress messages?

Value

A TRUE/FALSE whether or not the repository exists. Optionally the output from git ls-remote if return_repo = TRUE.

Examples

if (FALSE) {
retrieve_org_chapters(
  org_name = "jhudsl",
  output_file = "jhudsl_chapter_info.tsv"
)
}