Merge pull request #9 from PetterHopp/main

OKplan v0.4.2

Author: PetterHopp

CONTRIBUTING.md

@@ -66,11 +66,15 @@ data reporting at the Norwegian Veterinary Institute (NVI).
 <td style="text-align: left;">Public</td>
 <td style="text-align: left;">Tools to facilitate the development of NVIverse packages</td>
 </tr>
+<tr class="odd">
+<td style="text-align: left;">NVIrpackages</td>
+<td style="text-align: left;">Public</td>
+<td style="text-align: left;">Keeps a table of the R-Packages in NVIverse</td>
+</tr>
 </tbody>
 </table>
 
-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)

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,27 +21,26 @@ 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,
     NVIpackager
 Remotes: 
     NorwegianVeterinaryInstitute/NVIdb,
     NorwegianVeterinaryInstitute/NVIpretty,
-    NorwegianVeterinaryInstitute/NVIpackager
-RoxygenNote: 7.1.1
+    NorwegianVeterinaryInstitute/NVIpackager,
+    NorwegianVeterinaryInstitute/NVIrpackages
+RoxygenNote: 7.1.2
 VignetteBuilder: knitr
 Language: en-GB

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)
 ---------------------------
 

README.Rmd

@@ -6,6 +6,7 @@ output:
 
 params:
   NVIpkg: "OKplan"
+  first_copyright_year: "2021"
 ---
 
 ```{r, include = FALSE}

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
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
@@ -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 &gt; 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.
 
-<!-- Code of conduct -->
-------------------------
+## <!-- Code of conduct -->
 
 Please note that the OKplan project is released with a [Contributor Code
 of

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")

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`.