List Files in Github Repo — list_files_github_repo • funspotr

Return a dataframe containing the paths of files in a github repostiory. Generally used prior to spot_{funs/pkgs}_files().

Usage

list_files_github_repo(
  repo,
  branch = NULL,
  rmv_index = TRUE,
  keep_non_r = FALSE
)

Arguments

repo: Github repository, e.g. "brshallo/feat-eng-lags-presentation"
branch: Branch of github repository, default is "main".
rmv_index: Logical, most repos containing blogdown sites will have an index.R file at the root. Change to FALSE if you don't want this file removed.
keep_non_r: Logical, default is FALSE so keeps only records with relative_path ending in "(r|rmd|rmarkdown)$".

Value

Dataframe with columns of relative_paths and absolute_paths for file path locations. absolute_paths will be urls to raw files.

See also

list_files_wd(), list_files_github_gists()

Examples

if (FALSE) {
library(dplyr)
library(funspotr)

# pulling and analyzing my R file github gists
gh_urls <- list_files_github_repo("brshallo/feat-eng-lags-presentation", branch = "main")

# Will just parse the first 2 files/gists
contents <- spot_funs_files(slice(gh_urls, 1:2))

contents %>%
  unnest_results()
}