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  177 rbuildignore   file
#> 2           .github          .github    0       github    dir
#> 3        .gitignore       .gitignore  272    gitignore config
#> 4       DESCRIPTION      DESCRIPTION 1575                file
#> 5           LICENSE          LICENSE   48                file
#> 6        LICENSE.md       LICENSE.md 1077           md   text
#> 7         NAMESPACE        NAMESPACE 1223                file
#> 8           NEWS.md          NEWS.md 5629           md   text
#> 9                 R                R    0                 dir
#> 10        README.md        README.md  722           md   text
#> 11           _stuff           _stuff    0                 dir
#> 12             data             data    0                 dir
#> 13         data-raw         data-raw    0                 dir
#> 14             inst             inst    0                 dir
#> 15              man              man    0                 dir
#> 16 papercheck.Rproj papercheck.Rproj  462        rproj config
#> 17          pkgdown          pkgdown    0                 dir
#> 18          profile          profile    0                 dir
#> 19            tests            tests    0                 dir
#> 20        vignettes        vignettes    0                 dir
#> 
#> $languages
#>     language  bytes
#> 1          R 299984
#> 2       AMPL   7578
#> 3     Python   6986
#> 4        CSS   3358
#> 5 JavaScript   1018
#> 6       SCSS     19
#> 
# }