Get README from GitHub

Usage

github_readme(repo)

Arguments

repo: The URL of the repository (in the format "username/repo" or "https://github.com/username/repo")

Value

a character string of the README contents

Examples

# \donttest{
if (online("api.github.com")) {
  # GitHub can refuse when its request limit is reached; then this says why
  tryCatch(github_readme("scienceverse/metacheck"),
           error = function(e) message(conditionMessage(e)))
}
#> [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"
# }