retrieve_org_repos: Retrieve all bookdown chapters for an org

View source: R/retrieve_org_repos.R

retrieve_org_reposR Documentation

Retrieve all bookdown chapters for an org

Description

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_repos(
  org_name = NULL,
  output_file = "org_repos.tsv",
  git_pat = NULL,
  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_repos.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().

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


retrieve_org_repos(
  org_name = "jhudsl",
  output_file = "jhudsl_repos.tsv"
)

jhudsl/cow documentation built on April 17, 2025, 3:14 p.m.