NVIpjsrtools for retrieving, standardising, wrangling, preparing and
reporting PJS data and EOS data. NVIpjsr was created by separating out
PJS-functions from NVIdb. Further development of and creation of new
PJS-functions will take place within NVIpjsr.
NVIpjsr is part of NVIverse, a collection of R-packages with tools
to facilitate data management and data reporting at the Norwegian
Veterinary Institute (NVI). The NVIverse consists of the following
packages: NVIconfig, NVIdb, NVIpjsr, NVIspatial, NVIpretty,
NVIbatch, OKplan, OKcheck, NVIcheckmate, NVIpackager,
NVIrpackages. See Contribute to
NVIpjsr
for more information.
NVIpjsr is available in package manager for workbench and at
GitHub. If needed,
you can install the development version from the dev-branch at the
GitHub repo, see below.
To install NVIpjsr on workbench, run the following code:
install.packages("NVIpjsr")
If you need changes that only are available in the development version, please make contact to the developers so that a new release can be published on Workbench.
You may install the package with or without vignettes. Although it will
be easier to install without vignettes, it is recommended to install
with vignettes for all NVIverse packages except
c("NVIrpackages", "NVIconfig").
To install NVIpjsr you will need:
- R version > 4.1.0
- R package
remotes - Rtools version 4.0, 4.2, 4.3, 4.4 or 4.5 depending on R version
First install and attach the remotes package.
install.packages("remotes")
library(remotes)
To install (or update) NVIpjsr without vignettes, run the following
code:
remotes::install_github("NorwegianVeterinaryInstitute/NVIpjsr",
upgrade = FALSE,
build = TRUE,
build_vignettes = FALSE)
To install (or update) NVIpjsr with vignettes, you will need to first
install some additional R-packages needed to build the vignettes. Check
README below in the section Vignettes to see the vignettes
that are available. To install the package with the vignettes, first
install the packages: knitr, rmarkdown, R.rsp, and NVIrpackages
(from GitHub) if they are missing. If you don’t use R-studio, you will
also need to install Pandoc. Then run the following code:
remotes::install_github("NorwegianVeterinaryInstitute/NVIpjsr",
upgrade = FALSE,
build = TRUE,
build_vignettes = TRUE)
To install (or update) the development version (dev-branch) of NVIpjsr
(with vignettes), run the following code:
remotes::install_github("NorwegianVeterinaryInstitute/NVIpjsr",
ref = "dev",
upgrade = FALSE,
build = TRUE,
build_vignettes = TRUE)
The NVIpjsr package needs to be attached.
library(NVIpjsr)
NVIpjsr tools for retrieving, standardising, wrangling, preparing and
reporting PJS data and EOS data. NVIpjsr was created by separating out
PJS-functions from NVIdb. Further development of and creation of new
PJS-functions will take place within NVIpjsr.
The full list of all available functions and datasets can be accessed by typing
help(package = "NVIpjsr")
Consult the vignettes for task-oriented help.
vignette(package = "NVIpjsr")
Vignettes in package NVIpjsr:
- Contribute to NVIpjsr (html)
- NVIpjsr reference manual (pdf)
- Retrieve and standardise PJS-data (html)
Please check the NEWS for information on new features, bug fixes and other changes.
Copyright (c) 2024 - 2026 Norwegian Veterinary Institute.
Licensed under the BSD_3_clause License. See
License
for details.
Contributions to develop NVIpjsr 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.
See Contribute to
NVIpjsr
for more information.
Please note that the NVIpjsr project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.