Skip to contents

Get File List from GitHub

Usage

github_files(repo, dir = "", recursive = FALSE)

Arguments

repo

The URL of the repository (in the format "username/repo" or "https://github.com/username/repo")

dir

an optional directory name to search

recursive

whether to search the files recursively

Value

a data frame of files

Examples

# \donttest{
  github_files("scienceverse/papercheck")
#>                name             path  size          ext   type
#> 1     .Rbuildignore    .Rbuildignore   211 rbuildignore   file
#> 2           .github          .github     0       github    dir
#> 3        .gitignore       .gitignore   301    gitignore config
#> 4       DESCRIPTION      DESCRIPTION  1671                file
#> 5        LICENSE.md       LICENSE.md 34303           md   text
#> 6         NAMESPACE        NAMESPACE  1909                file
#> 7           NEWS.md          NEWS.md 10872           md   text
#> 8                 R                R     0                 dir
#> 9         README.md        README.md   722           md   text
#> 10           _stuff           _stuff     0                 dir
#> 11      codecov.yml      codecov.yml   134          yml config
#> 12             data             data     0                 dir
#> 13         data-raw         data-raw     0                 dir
#> 14             docs             docs     0                 dir
#> 15             inst             inst     0                 dir
#> 16              man              man     0                 dir
#> 17 papercheck.Rproj papercheck.Rproj   462        rproj config
#> 18          pkgdown          pkgdown     0                 dir
#> 19          profile          profile     0                 dir
#> 20            tests            tests     0                 dir
#> 21        vignettes        vignettes     0                 dir
# }