refdb_report {refdb}

Compile a report with different checks

Description

This function produce an HTML report to investigate potential issues in a reference database.

Usage

refdb_report(x, file = NULL, view = TRUE)

Arguments

x

a reference database.

file

the file (path) to write the report. If NULL the report is written in the user temp directory.

view

A logical. If TRUE (default), the file is instantly opened in the web browser.

Value

The function invisibly returns the file where the report was written.

Examples

lib <- read.csv(system.file("extdata", "ephem.csv", package = "refdb"))
lib <- refdb_set_fields(lib,
                        taxonomy = c(family = "family_name",
                            genus = "genus_name",
                            species = "species_name"),
                        sequence = "DNA_seq",
                        marker = "marker")
tmp <- tempfile()

refdb_report(lib, tmp, view = FALSE)