diff --git a/.Rbuildignore b/.Rbuildignore index bc1cb41..f38bf30 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -11,3 +11,4 @@ ^index\.md$ ^README\.md$ ^codemeta\.json$ +^\.github$ diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml index 7e47930..19f63fb 100644 --- a/.github/workflows/R-CMD-check.yaml +++ b/.github/workflows/R-CMD-check.yaml @@ -20,9 +20,12 @@ jobs: fail-fast: false matrix: config: - - {os: windows-latest, r: '4.0'} + - {os: windows-latest, r: 'devel'} + - {os: windows-latest, r: 'oldrel'} + - {os: windows-latest, r: 'release'} env: + GITHUB_PAT: ${{ secrets.MY_PUBLIC_PAT }} R_REMOTES_NO_ERRORS_FROM_WARNINGS: true RSPM: ${{ matrix.config.rspm }} @@ -64,7 +67,7 @@ jobs: shell: Rscript {0} - name: Check - run: rcmdcheck::rcmdcheck(args = "--no-manual", error_on = "warning", check_dir = "check") + run: rcmdcheck::rcmdcheck(args = c("--no-manual", "--ignore-vignettes", "--no-build-vignettes"), build_args = c("--no-manual", "--ignore-vignettes", "--no-build-vignettes"), error_on = "error", check_dir = "check") shell: Rscript {0} - name: Upload check results diff --git a/DESCRIPTION b/DESCRIPTION index 3a43ac0..df89951 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,61 +1,59 @@ Package: pkgmeta Title: R Package for Meta-Analysis of KWB-R Packages on Github -Version: 0.1.0.9000 -Authors@R: - c(person(given = "Michael", - family = "Rustler", - role = c("aut", "cre"), - email = "michael.rustler@kompetenz-wasser.de", - comment = c(ORCID = "0000-0003-0647-7726")), - person(given = "Kompetenzzentrum Wasser Berlin gGmbH (KWB)", - role = "cph")) -Description: R Package for meta-analysis of KWB-R packages on - Github. It is a wrapper to the R packages 'codemetar' and 'pkgnet' for - providing insights into the development of the R packages on Github. +Version: 0.2.0 +Authors@R: c( + person("Michael", "Rustler", , "michael.rustler@kompetenz-wasser.de", role = c("aut", "cre"), + comment = c(ORCID = "0000-0003-0647-7726")), + person("Hauke", "Sonnenberg", , "hauke.sonnenberg@kompetenz-wasser.de", role = "ctb", + comment = c(ORCID = "0000-0001-9134-2871")), + person("FAKIN", role = "fnd"), + person("Kompetenzzentrum Wasser Berlin gGmbH (KWB)", role = "cph") + ) +Description: R Package for meta-analysis of KWB-R packages on Github. It + is a wrapper to the R packages 'codemetar' and 'pkgnet' for providing + insights into the development of the R packages on Github. License: MIT + file LICENSE URL: https://github.com/KWB-R/pkgmeta BugReports: https://github.com/KWB-R/pkgmeta/issues Imports: codemetar, + dplyr, + forcats, + ggplot2, gh, - lubridate, + glue, jsonlite, kwb.pkgstatus, kwb.utils, - stringr, - withr, - scales, - purrr, - fs, - ggplot2, - glue, - forcats, - dplyr, + lubridate, + magrittr, packrat, plotly, + purrr, remotes, rversions, - magrittr, + stringr, tibble, - tidyr + tidyr, + withr Suggests: covr, - knitr, htmlwidgets, - rmarkdown, jsonld, + knitr, pkgnet, printr, + rmarkdown, sessioninfo, wordcloud2 VignetteBuilder: knitr Remotes: - github::Lchiffon/wordcloud2, github::kwb-r/kwb.pkgstatus, github::kwb-r/kwb.utils, + github::Lchiffon/wordcloud2, github::ropensci/codemetar@v0.3.0, github::UptakeOpenSource/pkgnet@d1e974de299d46e71b082e027a71b8b254edc9b2 Encoding: UTF-8 LazyData: true -RoxygenNote: 7.1.1 +RoxygenNote: 7.1.2 diff --git a/LICENSE b/LICENSE index b4be1a4..2b05dc0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ # MIT License -Copyright (c) 2018-2020 Kompetenzzentrum Wasser Berlin gGmbH (KWB) +Copyright (c) 2018-2022 Kompetenzzentrum Wasser Berlin gGmbH (KWB) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/LICENSE.md b/LICENSE.md index b4be1a4..2b05dc0 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # MIT License -Copyright (c) 2018-2020 Kompetenzzentrum Wasser Berlin gGmbH (KWB) +Copyright (c) 2018-2022 Kompetenzzentrum Wasser Berlin gGmbH (KWB) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/NEWS.md b/NEWS.md index ebd76aa..0ede621 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,7 @@ +# [pkgmeta 0.2.0](https://github.com/KWB-R/pkgmeta/releases/tag/v0.2.0) 2022-06-01 + +* Harmonise with [kwb.pkgbuild](https://github.com/kwb-r/kwb.pkgbuild) + # pkgmeta 0.1.0 * first release on Zenodo diff --git a/R/get_pkg_dependencies.R b/R/get_pkg_dependencies.R index 593f973..78dafeb 100644 --- a/R/get_pkg_dependencies.R +++ b/R/get_pkg_dependencies.R @@ -3,7 +3,7 @@ #' @param pkgs character vector with package names #' @param library_path character vector with path(s) to R library (default: .libPaths()) #' @param dbg logical if debug should be shown (default: TRUE) -#' @param ... additional arguments passed to \link[packrat]{getPackageDependencies} +#' @param ... additional arguments passed to packrat:::getPackageDependencies() #' @return list with package dependencies #' @importFrom stats setNames #' @export diff --git a/R/get_recursive_pkg_dependencies.R b/R/get_recursive_pkg_dependencies.R index 80d3784..a5b8396 100644 --- a/R/get_recursive_pkg_dependencies.R +++ b/R/get_recursive_pkg_dependencies.R @@ -3,7 +3,7 @@ #' @param pkgs character vector with package names #' @param library_path character vector with path(s) to R library (default: .libPaths()) #' @param dbg logical if debug should be shown (default: TRUE) -#' @param ... additional arguments passed to \link[packrat]{getPackageDependencies} +#' @param ... additional arguments passed to packrat:::getPackageDependencies() #' @return list with recursive package dependencies #' @importFrom stats setNames #' @export diff --git a/R/plot_r_releases.R b/R/plot_r_releases.R index cebce3c..81667b5 100644 --- a/R/plot_r_releases.R +++ b/R/plot_r_releases.R @@ -18,9 +18,9 @@ get_r_releases <- function(releases = rversions::r_versions(dots = TRUE)) { dplyr::mutate(patch = dplyr::if_else(is.na(.data$patch), 0L, as.integer(.data$patch)), major = as.integer(.data$major), minor = as.integer(.data$minor), - diff.major = major - dplyr::lag(.data$major, n = 1L), - diff.minor = minor - dplyr::lag(.data$minor, n = 1L), - diff.patch = patch - dplyr::lag(.data$patch, n = 1L), + diff.major = .data$major - dplyr::lag(.data$major, n = 1L), + diff.minor = .data$minor - dplyr::lag(.data$minor, n = 1L), + diff.patch = .data$patch - dplyr::lag(.data$patch, n = 1L), release_type = dplyr::if_else(.data$diff.major > 0, "Major", dplyr::if_else(.data$diff.minor > 0, diff --git a/README.md b/README.md index da442d2..a53ab6f 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ [![codecov](https://codecov.io/github/KWB-R/pkgmeta/branch/main/graphs/badge.svg)](https://codecov.io/github/KWB-R/pkgmeta) [![Project Status](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental) [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/pkgmeta)]() +[![R-Universe_Status_Badge](https://kwb-r.r-universe.dev/badges/pkgmeta)](https://kwb-r.r-universe.dev/) +[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.3604092.svg)](10.5281/zenodo.3604092) # pkgmeta diff --git a/_pkgdown.yml b/_pkgdown.yml index b4a3648..842f2ed 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,16 +1,27 @@ +url: https://kwb-r.github.io/pkgmeta authors: Michael Rustler: - href: http://mrustl.de + href: https://mrustl.de + Hauke Sonnenberg: + href: https://github.com/hsonne + FAKIN: + href: https://www.kompetenz-wasser.de/en/forschung/projekte/fakin + html: Project FAKIN Kompetenzzentrum Wasser Berlin gGmbH (KWB): - href: http://www.kompetenz-wasser.de - html: + href: https://www.kompetenz-wasser.de + html: KWB + template: - params: - bootswatch: cerulean - docsearch: - api_key: 38d84b8fc2ffc9261cc5cb2e13fc8ef5 - index_name: kwb_pkgmeta + bootstrap: 5 + bootswatch: cerulean + bslib: + bg: "#ffffff" + fg: "#000000" + primary: "#007aff" + border-radius: 0.5rem + btn-border-radius: 0.25rem development: mode: auto diff --git a/index.md b/index.md index 5c9f445..96d1ee8 100644 --- a/index.md +++ b/index.md @@ -3,6 +3,8 @@ [![codecov](https://codecov.io/github/KWB-R/pkgmeta/branch/main/graphs/badge.svg)](https://codecov.io/github/KWB-R/pkgmeta) [![Project Status](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental) [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/pkgmeta)]() +[![R-Universe_Status_Badge](https://kwb-r.r-universe.dev/badges/pkgmeta)](https://kwb-r.r-universe.dev/) +[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.3604092.svg)](10.5281/zenodo.3604092) R Package for meta-analysis of KWB-R packages on Github. It is a wrapper to the R packages 'codemetar' and 'pkgnet' for @@ -10,20 +12,21 @@ providing insights into the development of the R packages on Github. ## Installation -For details on how to install KWB-R packages checkout our [installation tutorial](https://kwb-r.github.io/kwb.pkgbuild/articles/install.html). +For installing the latest release of this R package run the following code below: ```r -### Optionally: specify GitHub Personal Access Token (GITHUB_PAT) -### See here why this might be important for you: -### https://kwb-r.github.io/kwb.pkgbuild/articles/install.html#set-your-github_pat +# Enable repository from kwb-r +options(repos = c( + kwbr = 'https://kwb-r.r-universe.dev', + CRAN = 'https://cloud.r-project.org')) + +# Download and install pkgmeta in R +install.packages('pkgmeta') -# Sys.setenv(GITHUB_PAT = "mysecret_access_token") +# Browse the pkgmeta manual pages +help(package = 'pkgmeta') +``` -# Install package "remotes" from CRAN -if (! require("remotes")) { - install.packages("remotes", repos = "https://cloud.r-project.org") -} +## Usage -# Install KWB package 'pkgmeta' from GitHub -remotes::install_github("KWB-R/pkgmeta") -``` +Checkout the available [articles](articles/) on how to use this R package. diff --git a/man/get_pkg_dependencies.Rd b/man/get_pkg_dependencies.Rd index 7275267..c45cc67 100644 --- a/man/get_pkg_dependencies.Rd +++ b/man/get_pkg_dependencies.Rd @@ -13,7 +13,7 @@ get_pkg_dependencies(pkgs, library_path = .libPaths(), dbg = TRUE, ...) \item{dbg}{logical if debug should be shown (default: TRUE)} -\item{...}{additional arguments passed to \link[packrat]{getPackageDependencies}} +\item{...}{additional arguments passed to packrat:::getPackageDependencies()} } \value{ list with package dependencies diff --git a/man/get_recursive_pkg_dependencies.Rd b/man/get_recursive_pkg_dependencies.Rd index ae94524..f865fef 100644 --- a/man/get_recursive_pkg_dependencies.Rd +++ b/man/get_recursive_pkg_dependencies.Rd @@ -18,7 +18,7 @@ get_recursive_pkg_dependencies( \item{dbg}{logical if debug should be shown (default: TRUE)} -\item{...}{additional arguments passed to \link[packrat]{getPackageDependencies}} +\item{...}{additional arguments passed to packrat:::getPackageDependencies()} } \value{ list with recursive package dependencies diff --git a/vignettes/visualisation.Rmd b/vignettes/visualisation.Rmd index 3e16173..12cdb25 100644 --- a/vignettes/visualisation.Rmd +++ b/vignettes/visualisation.Rmd @@ -41,7 +41,7 @@ cat("[Overview of R releases](../r_releases.html)") ### Temporal Development -```{r, eval = TRUE, fig.height = 9, fig.width = 7} +```{r, eval = TRUE, fig.height = 13, fig.width = 7} #pkgmeta::get_gh_ratelimit() pkgs <- pkgmeta::get_github_packages()