From 2fc6fefb03d2e22e46815f98fce8f32961c1d811 Mon Sep 17 00:00:00 2001 From: Petter Hopp Date: Thu, 20 Jan 2022 14:14:53 +0100 Subject: [PATCH 1/6] chore: Included new NVIverse package in CONTRIBUTING --- CONTRIBUTING.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96ba540..5c795cf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,11 +66,15 @@ data reporting at the Norwegian Veterinary Institute (NVI). Public Tools to facilitate the development of NVIverse packages + +NVIrpackages +Public +Keeps a table of the R-Packages in NVIverse + -How you can contribute ----------------------- +## How you can contribute There are several ways you can contribute to this project: ask a question, propose an idea, report a bug, improve the documentation, or @@ -136,8 +140,7 @@ list](https://github.com/NorwegianVeterinaryInstitute/OKplan/issues) and leave a comment on the things you want to work on. See also the development guidelines below. -Development guidelines ----------------------- +## Development guidelines If you want to contribute code, you are welcome to do so. Please try to adhere to some principles and style convention used for @@ -153,7 +156,7 @@ adhere to some principles and style convention used for Please don’t restyle code that has nothing to do with your pull request. -- You should add a bullet point to `NEWS.md` motivating the change. +- You should add a bullet point to `NEWS` motivating the change. - You should add yourself as a contributor to the `DESCRIPTION`. @@ -199,15 +202,13 @@ The start of commit messages should be one of the following: Do not capitalize the first letter. -Code of conduct ---------------- +## Code of conduct Please note that this project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By participating to this project, you agree to abide by its terms. -References ----------- +## References This document is adapted from a [template](https://gist.github.com/peterdesmet/e90a1b0dc17af6c12daf6e8b2f044e7c) From 8514fb7f833f109282fbae85ff42ccd2ef79a7c4 Mon Sep 17 00:00:00 2001 From: Petter Hopp Date: Thu, 20 Jan 2022 14:17:13 +0100 Subject: [PATCH 2/6] chore: included first_copyright_year to README.Rmd --- README.Rmd | 1 + 1 file changed, 1 insertion(+) diff --git a/README.Rmd b/README.Rmd index 85be315..c538662 100644 --- a/README.Rmd +++ b/README.Rmd @@ -6,6 +6,7 @@ output: params: NVIpkg: "OKplan" + first_copyright_year: "2021" --- ```{r, include = FALSE} From 977829a1fefc0b5f7a467f4f199b998effa04069 Mon Sep 17 00:00:00 2001 From: Petter Hopp Date: Thu, 20 Jan 2022 14:18:32 +0100 Subject: [PATCH 3/6] chore: updated README.md with new templates --- README.md | 38 ++++++++++++++++---------------------- 1 file changed, 16 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index f1d6ca1..c3890a2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -OKplan: Tools to facilitate the Planning of the annual Surveillance Programmes -============================================================================== +# OKplan: Tools to facilitate the Planning of the annual Surveillance Programmes @@ -9,8 +8,7 @@ OKplan: Tools to facilitate the Planning of the annual Surveillance Programmes - [Copyright and license](#copyright-and-license) - [Contributing](#contributing) -Overview --------- +## Overview `OKplan`provide tools to facilitate the planning of the annual surveillance programmes. The main focus is tools for generating @@ -20,17 +18,16 @@ standardized lists for NFSA. facilitate data management and data reporting at the Norwegian Veterinary Institute (NVI). The NVIverse consists of the following packages: NVIconfig, NVIdb, NVIpretty, NVIbatch, OKplan, OKcheck, -NVIcheckmate, NVIpackager. See the vignette “Contribute to OKplan” for -more information. +NVIcheckmate, NVIpackager, NVIrpackages. See the vignette “Contribute to +OKplan” for more information. -Installation ------------- +## Installation `OKplan` is available at [GitHub](https://github.com/NorwegianVeterinaryInstitute). To install `OKplan` you will need: -- R version > 4.0.0 +- R version > 4.0.0 - R package `remotes` - Rtools 4.0 @@ -41,47 +38,44 @@ First install and attach the `remotes` package. To install (or update) the `OKplan` package, run the following code: - remotes::install_github("NorwegianVeterinaryInstitute/OKplan") + remotes::install_github("NorwegianVeterinaryInstitute/OKplan", upgrade = FALSE, build = TRUE, build_manual = TRUE) -Usage ------ +## Usage The `OKplan` package needs to be attached. - library(NVIdb) + library(OKplan) `OKplan`provide tools to facilitate the planning of the annual surveillance programmes. The main focus is tools for generating standardized lists for NFSA. -The list of available functions and datasets can be accessed by typing +The full list of all available functions and datasets can be accessed by +typing - help(package="NVIdb") + help(package = "OKplan") Please check the NEWS for information on new features, bug fixes and other changes. -Copyright and license ---------------------- +## Copyright and license -Copyright (c) 2021 Norwegian Veterinary Institute. +Copyright (c) 2021 - 2022 Norwegian Veterinary Institute. Licensed under the BSD\_3\_clause License. See [License](https://github.com/NorwegianVeterinaryInstitute/OKplan/blob/main/LICENSE) for details. -Contributing ------------- +## Contributing Contributions to develop `OKplan` is highly appreciated. There are several ways you can contribute to this project: ask a question, propose an idea, report a bug, improve the documentation, or contribute code. The vignette “Contribute to OKplan” gives more information. - ------------------------- +## Please note that the OKplan project is released with a [Contributor Code of From 9e17d9fad2a49027e58f3db22989256035fd8e8e Mon Sep 17 00:00:00 2001 From: Petter Hopp Date: Thu, 20 Jan 2022 14:19:50 +0100 Subject: [PATCH 4/6] chore: updated Contribute_to_OKplan with new template --- vignettes/Contribute_to_OKplan.Rmd | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/vignettes/Contribute_to_OKplan.Rmd b/vignettes/Contribute_to_OKplan.Rmd index e02a0e5..eb1ca6c 100644 --- a/vignettes/Contribute_to_OKplan.Rmd +++ b/vignettes/Contribute_to_OKplan.Rmd @@ -21,8 +21,6 @@ vignette: > NVIpkg <- params$NVIpkg NVIpkg_inline <- paste0("`", NVIpkg, "`") NVIpkg_code <- "/tree/main/R" -# pkg_name <- NVIpkg_inline -# pkg_name <- "`NVIcheckmate`" knitr::opts_chunk$set( collapse = TRUE, comment = "#>" @@ -40,8 +38,8 @@ Thank you for considering contributing to `r NVIpkg_inline`. ### NVIverse packages ```{r echo = FALSE, results = 'asis'} -library(NVIpackager) -knitr::kable(x = NVIpackages) +# library(NVIrpackages) +knitr::kable(x = NVIrpackages::NVIpackages) ``` ## How you can contribute @@ -95,7 +93,7 @@ I recommend to use the [`styler`](https://CRAN.R-project.org/package=styler) package to apply spaces: `styler::style_file(filename, scope = "spaces")`. Please don't restyle code that has nothing to do with your pull request. -* You should add a bullet point to `NEWS.md` motivating the change. +* You should add a bullet point to `NEWS` motivating the change. * You should add yourself as a contributor to the `DESCRIPTION`. From cbd025550cfe2fb162c2fb54732d831bcebe4db7 Mon Sep 17 00:00:00 2001 From: Petter Hopp Date: Thu, 20 Jan 2022 14:35:06 +0100 Subject: [PATCH 5/6] chore: refactored develop.R --- notes/develop.R | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/notes/develop.R b/notes/develop.R index 5d1f777..bbed4a5 100644 --- a/notes/develop.R +++ b/notes/develop.R @@ -7,11 +7,11 @@ # library(devtools) # library(roxygen2) library(NVIpackager) -library(spelling) +# library(spelling) # Global variables -pkg <- stringi::stri_extract_last_words(usethis::proj_path()) pkg_path = usethis::proj_path() +pkg <- stringi::stri_extract_last_words(pkg_path) # Rlibrary <- R.home() # create_NVIpkg_skeleton(license_keyword = "CC BY 4.0") From 6fb00a4f68628de629a3527ad744cc672cb3b501 Mon Sep 17 00:00:00 2001 From: Petter Hopp Date: Thu, 20 Jan 2022 14:40:32 +0100 Subject: [PATCH 6/6] chore: NEWS and DESCRIPTION V0.4.2 --- DESCRIPTION | 19 +++++++++---------- NEWS | 8 ++++++++ 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 389461d..450bea0 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: OKplan Title: Tools to facilitate the Planning of the annual Surveillance Programmes -Version: 0.4.1 -Date: 2021-12.17 +Version: 0.4.2 +Date: 2022-01-20 Authors@R: c(person(given = "Petter", family = "Hopp", @@ -21,19 +21,17 @@ LazyData: true Imports: checkmate, dplyr, + knitr, magrittr, openxlsx, + rmarkdown, stats, NVIdb (>= 0.3.0), - NVIpretty + NVIpretty, + NVIrpackages Suggests: covr, devtools, - knitr, - remotes, - rmarkdown, - roxygen2, - styler, testthat, usethis, utils, @@ -41,7 +39,8 @@ Suggests: Remotes: NorwegianVeterinaryInstitute/NVIdb, NorwegianVeterinaryInstitute/NVIpretty, - NorwegianVeterinaryInstitute/NVIpackager -RoxygenNote: 7.1.1 + NorwegianVeterinaryInstitute/NVIpackager, + NorwegianVeterinaryInstitute/NVIrpackages +RoxygenNote: 7.1.2 VignetteBuilder: knitr Language: en-GB diff --git a/NEWS b/NEWS index bf80eac..9277f7f 100644 --- a/NEWS +++ b/NEWS @@ -1,3 +1,11 @@ +OKplan 0.4.2 - (2022-01-20) +--------------------------- + +Bug fixes: + +- Fixed problems with package dependencies during installation. + + OKplan 0.4.1 - (2021-12-17) ---------------------------