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     198 rbuildignore   file
#> 2           .github          .github       0       github    dir
#> 3        .gitignore       .gitignore     267    gitignore config
#> 4       DESCRIPTION      DESCRIPTION    1632                file
#> 5           LICENSE          LICENSE      48                file
#> 6        LICENSE.md       LICENSE.md   34303           md   text
#> 7         NAMESPACE        NAMESPACE    1856                file
#> 8           NEWS.md          NEWS.md    7393           md   text
#> 9                 R                R       0                 dir
#> 10        README.md        README.md     722           md   text
#> 11     _report.html     _report.html 1401488         html    web
#> 12           _stuff           _stuff       0                 dir
#> 13             data             data       0                 dir
#> 14         data-raw         data-raw       0                 dir
#> 15             docs             docs       0                 dir
#> 16             inst             inst       0                 dir
#> 17              man              man       0                 dir
#> 18 papercheck.Rproj papercheck.Rproj     462        rproj config
#> 19          pkgdown          pkgdown       0                 dir
#> 20          profile          profile       0                 dir
#> 21            tests            tests       0                 dir
#> 22        vignettes        vignettes       0                 dir
# }