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

NVIprettyprovides tools for styling output from R in accord with NVI’s graphical profile. Included are colour palettes and a NVI-theme for ggplot2 as well as tools to format and style output in Excel.

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

NVIpretty provide tools to make R-output pretty in accord with Norwegian Veterinary Institute’s (NVI) graphical profile. For products that are not described in the graphical profile, the tools should help standardizing the output and aid in increasing readability and use.

The package is under development. Currently the package comprises functions that standardizes output to Excel and palettes with colour codes for the NVI colours. Contributions to enhance the package is highly appreciated.

NVIpretty 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 NVIpretty on workbench, run the following code:

install.packages("NVIpretty")

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

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

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

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

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

The NVIpretty package needs to be attached.

library(NVIpretty)

For information on using the colour palettes and the NVI_theme in ggplot2, please have look at the vignette ‘Create graphs for NVI’.

NVIpretty can also be used to style an Excel sheet as in the example below.

# Attach packages and set up with temporary directory
library(NVIpretty)
library(openxlsx)
td <- tempdir()

# Generate Excel-sheet
workbook <- createWorkbook()

# Add a sheet to the workbook
add_formatted_worksheet(iris,
                        workbook,
                        sheet = "iris",
                        wrapHeadlineText = TRUE,
                        collabels = TRUE,
                        colwidths = FALSE,
                        standards = NULL)

#Save the workbook
saveWorkbook(wb = workbook,
             file = paste0(td, "/iris.xlsx"),
                          overwrite = TRUE)

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

help(package = "NVIpretty")

Consult the vignettes for task-oriented help.

vignette(package = "NVIpretty")

Vignettes in package NVIpretty:

• Contribute to NVIpretty (html)
• Create graphs for NVI (html)
• NVI colour palettes (html)
• NVIpretty reference manual (pdf)

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

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

Contributions to develop NVIpretty 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 NVIpretty for more information.

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