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{
if (online("api.github.com")) {
  # GitHub can refuse when its request limit is reached; then this says why
  tryCatch(github_info("scienceverse/metacheck"),
           error = function(e) message(conditionMessage(e)))
}
#> $repo
#> [1] "scienceverse/metacheck"
#> 
#> $readme
#> [1] "# metacheck\n\n<!-- badges: start -->\n[![DOI](https://zenodo.org/badge/926991536.svg)](https://doi.org/10.5281/zenodo.20704754)\n\n![Made in Europe](https://img.shields.io/badge/Made_in_Europe-003399?logo=european-union&logoColor=FFCC00)\n\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/metacheck/graph/badge.svg)](https://app.codecov.io/gh/scienceverse/metacheck)\n<!-- badges: end -->\n\nThe goal of metacheck is to automatically check research outputs for best practices. You can find out more at <https://www.scienceverse.org/metacheck/>.\n\n## Installation\n\nYou can install the development version of metacheck from [GitHub](https://github.com/) with:\n\n``` r\npak::pkg_install(\"scienceverse/metacheck\")\n```\n\n\n\n## Notes for Developers\n\nYou may not contribute any code unless you also contribute a test of this code.\n\nCheck tests/testthat/helper.R for custom test skip functions. All tests requiring a web connection, LLM, or long tests should be skipped or mocked. You can control this globally with the skip functions in this file (e.g., comment out the first `skip()` function in each custom function to run all tests of this type unless on cran/covr).\n"
#> 
#> $files
#>                      repo             clean_repo               name
#> 1  scienceverse/metacheck scienceverse/metacheck      .Rbuildignore
#> 2  scienceverse/metacheck scienceverse/metacheck     .gitattributes
#> 3  scienceverse/metacheck scienceverse/metacheck            .github
#> 4  scienceverse/metacheck scienceverse/metacheck         .gitignore
#> 5  scienceverse/metacheck scienceverse/metacheck            .vscode
#> 6  scienceverse/metacheck scienceverse/metacheck CODE_OF_CONDUCT.md
#> 7  scienceverse/metacheck scienceverse/metacheck    CONTRIBUTING.md
#> 8  scienceverse/metacheck scienceverse/metacheck        DESCRIPTION
#> 9  scienceverse/metacheck scienceverse/metacheck         LICENSE.md
#> 10 scienceverse/metacheck scienceverse/metacheck          NAMESPACE
#> 11 scienceverse/metacheck scienceverse/metacheck            NEWS.md
#> 12 scienceverse/metacheck scienceverse/metacheck                  R
#> 13 scienceverse/metacheck scienceverse/metacheck          README.md
#> 14 scienceverse/metacheck scienceverse/metacheck   _metacheck.Rproj
#> 15 scienceverse/metacheck scienceverse/metacheck        codecov.yml
#> 16 scienceverse/metacheck scienceverse/metacheck               data
#> 17 scienceverse/metacheck scienceverse/metacheck           data-raw
#> 18 scienceverse/metacheck scienceverse/metacheck               inst
#> 19 scienceverse/metacheck scienceverse/metacheck           makefile
#> 20 scienceverse/metacheck scienceverse/metacheck                man
#> 21 scienceverse/metacheck scienceverse/metacheck            pkgdown
#> 22 scienceverse/metacheck scienceverse/metacheck              tests
#>                  path
#> 1       .Rbuildignore
#> 2      .gitattributes
#> 3             .github
#> 4          .gitignore
#> 5             .vscode
#> 6  CODE_OF_CONDUCT.md
#> 7     CONTRIBUTING.md
#> 8         DESCRIPTION
#> 9          LICENSE.md
#> 10          NAMESPACE
#> 11            NEWS.md
#> 12                  R
#> 13          README.md
#> 14   _metacheck.Rproj
#> 15        codecov.yml
#> 16               data
#> 17           data-raw
#> 18               inst
#> 19           makefile
#> 20                man
#> 21            pkgdown
#> 22              tests
#>                                                                        download_url
#> 1       https://raw.githubusercontent.com/scienceverse/metacheck/main/.Rbuildignore
#> 2      https://raw.githubusercontent.com/scienceverse/metacheck/main/.gitattributes
#> 3                                                                              <NA>
#> 4          https://raw.githubusercontent.com/scienceverse/metacheck/main/.gitignore
#> 5                                                                              <NA>
#> 6  https://raw.githubusercontent.com/scienceverse/metacheck/main/CODE_OF_CONDUCT.md
#> 7     https://raw.githubusercontent.com/scienceverse/metacheck/main/CONTRIBUTING.md
#> 8         https://raw.githubusercontent.com/scienceverse/metacheck/main/DESCRIPTION
#> 9          https://raw.githubusercontent.com/scienceverse/metacheck/main/LICENSE.md
#> 10          https://raw.githubusercontent.com/scienceverse/metacheck/main/NAMESPACE
#> 11            https://raw.githubusercontent.com/scienceverse/metacheck/main/NEWS.md
#> 12                                                                             <NA>
#> 13          https://raw.githubusercontent.com/scienceverse/metacheck/main/README.md
#> 14   https://raw.githubusercontent.com/scienceverse/metacheck/main/_metacheck.Rproj
#> 15        https://raw.githubusercontent.com/scienceverse/metacheck/main/codecov.yml
#> 16                                                                             <NA>
#> 17                                                                             <NA>
#> 18                                                                             <NA>
#> 19           https://raw.githubusercontent.com/scienceverse/metacheck/main/makefile
#> 20                                                                             <NA>
#> 21                                                                             <NA>
#> 22                                                                             <NA>
#>      size           ext   type
#> 1     376  rbuildignore   file
#> 2    1017 gitattributes   file
#> 3       0        github    dir
#> 4    1394     gitignore config
#> 5       0        vscode    dir
#> 6    5240            md   text
#> 7    6620            md   text
#> 8    3333                 file
#> 9   34303            md   text
#> 10   7191                 file
#> 11 274526            md   text
#> 12      0                  dir
#> 13   1319            md   text
#> 14    462         rproj config
#> 15    134           yml config
#> 16      0                  dir
#> 17      0                  dir
#> 18      0                  dir
#> 19   1407                 file
#> 20      0                  dir
#> 21      0                  dir
#> 22      0                  dir
#> 
#> $languages
#>                      repo         language    bytes
#> 1  scienceverse/metacheck                R 28680017
#> 2  scienceverse/metacheck             HTML  7960734
#> 3  scienceverse/metacheck           Python   153529
#> 4  scienceverse/metacheck              Lua    92710
#> 5  scienceverse/metacheck              CSS    18875
#> 6  scienceverse/metacheck              TeX    14439
#> 7  scienceverse/metacheck            Stata    12520
#> 8  scienceverse/metacheck       JavaScript     9123
#> 9  scienceverse/metacheck            Typst     5329
#> 10 scienceverse/metacheck Jupyter Notebook     3394
#> 11 scienceverse/metacheck       Dockerfile     2975
#> 12 scienceverse/metacheck             SCSS     2860
#> 13 scienceverse/metacheck         Makefile     1407
#> 14 scienceverse/metacheck            Rebol       34
#> 15 scienceverse/metacheck            Shell       17
#> 
# }