OKplan: Tools to facilitate the Planning of the annual Surveillance Programmes

• Overview
• Installation
• Usage
• Copyright and license
• Contributing

Overview

OKplanprovide tools to facilitate the planning of the annual surveillance programmes. The main focus is tools for generating standardized lists for NFSA.

OKplan 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 OKplan for more information.

Installation

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

Workbench

To install OKplan on workbench, run the following code:

install.packages("OKplan")

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.

At personal computer

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 OKplan 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) OKplan without vignettes, run the following code:

remotes::install_github("NorwegianVeterinaryInstitute/OKplan",
    upgrade = FALSE,
    build = TRUE,
    build_vignettes = FALSE)

To install (or update) OKplan 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 which vignettes 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/OKplan",
    upgrade = FALSE,
    build = TRUE,
    build_vignettes = TRUE)

To install (or update) the development version (dev-branch) of OKplan (with vignettes), run the following code:

remotes::install_github("NorwegianVeterinaryInstitute/OKplan",
    ref = "dev",
    upgrade = FALSE,
    build = TRUE,
    build_vignettes = TRUE)

Usage

The OKplan package needs to be attached.

library(OKplan)

OKplanprovide tools to facilitate the planning of the annual surveillance programmes. The main focus is tools for generating standardized lists for NFSA.

Further documentation

Help

The full list of all available functions and datasets can be accessed by typing

help(package = "OKplan")

Vignettes

Consult the vignettes for task-oriented help.

vignette(package = "OKplan")

Vignettes in package OKplan:

• Contribute to OKplan (html)
• OKplan reference manual (pdf)

NEWS

Please check the NEWS for information on new features, bug fixes and other changes.

Copyright and license

Copyright (c) 2020 - 2025 Norwegian Veterinary Institute.
Licensed under the BSD_3_clause License. See License for details.

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. See Contribute to OKplan for more information.

Please note that the OKplan project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.