Get GitHub Repo Info

Usage

github_info(repo, recursive = FALSE)

Arguments

repo: The URL of the repository (in the format "username/repo" or "https://github.com/username/repo")
recursive: whether to search the files recursively

Value

a list of information about the repo

Examples

# \donttest{
  github_info("scienceverse/papercheck")
#> $repo
#> [1] "scienceverse/papercheck"
#> 
#> $readme
#> [1] "# papercheck\n\n<!-- badges: start -->\n[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)\n\n[![Codecov test coverage](https://codecov.io/gh/scienceverse/papercheck/graph/badge.svg)](https://app.codecov.io/gh/scienceverse/papercheck)\n<!-- badges: end -->\n\nThe goal of papercheck is to automatically check scientific papers for best practices. You can find out more at <https://scienceverse.github.io/papercheck/>.\n\n## Installation\n\nYou can install the development version of papercheck from [GitHub](https://github.com/) with:\n\n``` r\n# install.packages(\"devtools\")\ndevtools::install_github(\"scienceverse/papercheck\")\n```\n\n## API (optional)\nTo run papercheck as a REST API either using plumber or Docker, see [`inst/plumber/README.md`](inst/plumber/README.md) for instructions and documentation.\n"
#> 
#> $files
#>                name             path  size          ext   type
#> 1     .Rbuildignore    .Rbuildignore   247 rbuildignore   file
#> 2           .github          .github     0       github    dir
#> 3        .gitignore       .gitignore   387    gitignore config
#> 4       DESCRIPTION      DESCRIPTION  1871                file
#> 5        LICENSE.md       LICENSE.md 34303           md   text
#> 6         NAMESPACE        NAMESPACE  1978                file
#> 7           NEWS.md          NEWS.md 12115           md   text
#> 8                 R                R     0                 dir
#> 9         README.md        README.md   896           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
#> 
#> $languages
#>      language   bytes
#> 1        HTML 4360393
#> 2           R 2905592
#> 3         TeX   25601
#> 4        AMPL    7578
#> 5      Python    6986
#> 6         CSS    3358
#> 7  JavaScript    1018
#> 8  Dockerfile     933
#> 9        SCSS      19
#> 10      Shell      17
#> 
# }