Skip to content

Latest commit

 

History

History
119 lines (84 loc) · 3.76 KB

README.md

File metadata and controls

119 lines (84 loc) · 3.76 KB
Raw

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

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 at GitHub. To install OKplan you will need:

  • R version > 4.1.0
  • R package remotes
  • Rtools version 4.0, 4.2, 4.3 or 4.4 depending on R version

First install and attach the remotes package.

install.packages("remotes")
library(remotes)

To install (or update) the OKplan package without vignettes, run the following code:

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

To install (or update) the OKplan package 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)

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

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

Copyright and license

Copyright (c) 2020 - 2024 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.