list_files_wd: List Files in Working Directory

In brshallo/funspotr: Spot R Functions & Packages

List Files in Working Directory

Description

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

Usage

list_files_wd(
  path = ".",
  pattern = stringr::regex("(r|rmd|rmarkdown|qmd)$", ignore_case = TRUE),
  rmv_index = TRUE
)

Arguments

path	Character vector or path. Default is "." which will set the starting location for relative_paths.
pattern	Regex pattern to keep only matching files. Default is stringr::regex("(r|rmd|rmarkdown|qmd)$", ignore_case = TRUE) which will keep only R, Rmarkdown and Quarto documents. To keep all files use ".".
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.

Details

Can also be used outside of working directory if path is specified.

Value

Dataframe with columns of relative_paths and absolute_paths.

See Also

list_files_github_repo(), list_files_github_gists()

Examples

library(dplyr)
library(funspotr)

# pulling and analyzing my R file github gists
files_local <- list_files_wd()

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

contents %>%
  unnest_results()

brshallo/funspotr documentation built on Jan. 4, 2024, 10:08 a.m.