report: Creates a basic data quality report.

View source: R/report.R

reportR Documentation

Creates a basic data quality report.

Description

Creates a basic data quality report.

Usage

report(
  data,
  qc = NULL,
  file = "report.html",
  dir = NULL,
  view = TRUE,
  topnspecies = 20
)

Arguments

data

The data frame.

qc

QC errors, if not provided some tests are done on the provided data.

file

Output file (default is "report.html").

dir

Directory where to store the file (default is rappdirs::user_cache_dir("obistools")).

view

Logical, show the report in a browser after creation (default TRUE).

topnspecies

Integer, number of species ordered by number of records for which you want to do the outlier analysis

Value

Returns the full path to the generated html report.

Examples

## Not run: 
report(abra)

## End(Not run)

iobis/obistools documentation built on March 19, 2024, 6:27 a.m.