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"
#> 
#> $files
#>                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
#> 
#> $languages
#>     language   bytes
#> 1       HTML 4228749
#> 2          R  363020
#> 3        TeX   25601
#> 4       AMPL    7578
#> 5     Python    6986
#> 6        CSS    3358
#> 7 JavaScript    1018
#> 8       SCSS      19
#> 
# }