library(papercheck)
#>
#>
#> *******************************************
#> ✅ Welcome to PaperCheck
#> For support and examples visit:
#> https://scienceverse.github.io/papercheck/
#>
#> ⚠️ This is alpha software; please check any
#> results. False positives and negatives will
#> occur at unknown rates.
#> *******************************************There are some built-in functions in papercheck for exploring GitHub repositories. You can use these in custom modules.
github_repo
The github functions all work with the following formats for referring to repositories:
-
"{username}/{repo}"
-
"{username}/{repo}.git"
-
"https://github.com/{username}/{repo}.git"
"https://github.com/{username}/{repo}/{...}"
The github_repo() function returns the simplified format
of. repo name, and an error if the repository in inaccessible.
github_repo("https://github.com/scienceverse/papercheck.git")
#> [1] "scienceverse/papercheck"
github_repo("scienceverse/checkpaper")
#> [1] "unavailable"github_readme
Get the text of the readme file, regardless of the exact file name (e.g., README vs README.md).
readme <- github_readme("scienceverse/papercheck")
cat(readme)#> # papercheck
#>
#> <!-- badges: start -->
#> [](https://lifecycle.r-lib.org/articles/stages.html#experimental)
#>
#> [](https://app.codecov.io/gh/scienceverse/papercheck)
#> <!-- badges: end -->
#>
#> The goal of papercheck is to automatically check scientific papers for best practices. You can find out more at <https://scienceverse.github.io/papercheck/>.
#>
#> ## Installation
#>
#> You can install the development version of papercheck from [GitHub](https://github.com/) with:
#>
#> ``` r
#> # install.packages("devtools")
#> devtools::install_github("scienceverse/papercheck")
#> ```github_languages
You can retrieve the number of bytes dedicated to various coding languages, as detected and classified by GitHub.
github_languages("scienceverse/papercheck")
#> language bytes
#> 1 HTML 2951793
#> 2 R 2876797
#> 3 TeX 25601
#> 4 AMPL 7578
#> 5 Python 6986
#> 6 CSS 3358
#> 7 JavaScript 1018
#> 8 SCSS 19github_files
You can get a list of file names, their path, size, file extension, and a guess at their type.
By default, you just retrieve the files and directories in the base directory, non-recursively.
github_files("scienceverse/papercheck")
#> name path size ext type
#> 1 _stuff _stuff 0 dir
#> 2 .github .github 0 github dir
#> 3 .gitignore .gitignore 301 gitignore config
#> 4 .Rbuildignore .Rbuildignore 211 rbuildignore file
#> 5 codecov.yml codecov.yml 134 yml config
#> 6 data data 0 dir
#> 7 data-raw data-raw 0 dir
#> 8 DESCRIPTION DESCRIPTION 1671 file
#> 9 docs docs 0 dir
#> 10 inst inst 0 dir
#> 11 LICENSE.md LICENSE.md 34303 md text
#> 12 man man 0 dir
#> 13 NAMESPACE NAMESPACE 1909 file
#> 14 NEWS.md NEWS.md 10872 md text
#> 15 papercheck.Rproj papercheck.Rproj 462 rproj config
#> 16 pkgdown pkgdown 0 dir
#> 17 profile profile 0 dir
#> 18 R R 0 dir
#> 19 README.md README.md 722 md text
#> 20 tests tests 0 dir
#> 21 vignettes vignettes 0 dir
github_files("scienceverse/papercheck", dir = ".github")
#> name path size ext type
#> 1 .gitignore .github/.gitignore 7 gitignore config
#> 2 workflows .github/workflows 0 dirYou can also retrieve files recursively. Searching a large repository recursively can take a while.
github_files("scienceverse/papercheck",
dir = ".github",
recursive = TRUE)
#> name path size ext type
#> 1 .gitignore .github/.gitignore 7 gitignore config
#> 2 workflows .github/workflows 0 dir
#> 3 pkgdown.yaml .github/workflows/pkgdown.yaml 1364 yaml config
#> 4 test-coverage.yaml .github/workflows/test-coverage.yaml 1850 yaml configgithub_info
Get all of the information about a repository in one list object, with items named “repo”, “readme”, “languages”, and “files”.
github_info("scienceverse/demo")
#> $repo
#> [1] "scienceverse/demo"
#>
#> $readme
#> [1] "# demo\nFor use in testing functions\n"
#>
#> $files
#> name path size ext type
#> 1 folder folder 0 dir
#> 2 README.md README.md 36 md text
#>
#> $languages
#> [1] language
#> <0 rows> (or 0-length row.names)