bdc (version 1.1.6)

bdc_create_report: Create a report summarizing the results of data quality tests

Description

Create a report summarizing the results of data quality tests

Usage

bdc_create_report(
  data,
  database_id = "database_id",
  workflow_step,
  save_report = FALSE
)

Value

A data.frame containing a report summarizing the results of data quality assessment.

Arguments

data

data.frame. Containing a unique identifier for each record and the results of data quality tests.

database_id

character string. The column name with a unique record identifier.Default = "database_id".

workflow_step

character string containing the following options("prefilter", "taxonomy", "space" or "time").

save_report

logical. Should the report be saved for further inspection? Default = FALSE.

Examples

if (FALSE) {
database_id <- c("test_1", "test_2", "test_3", "test_4", "test_5")
.missing_names <- c(TRUE, TRUE, TRUE, FALSE, FALSE)
.missing_coordinates <- c(TRUE, FALSE, FALSE, TRUE, FALSE)
.basisOfRecords_notStandard <- c(TRUE, TRUE, FALSE, TRUE, TRUE)
.summary <- c(TRUE, FALSE, FALSE, FALSE, FALSE)

x <- data.frame(
  database_id,
  .missing_names,
  .missing_coordinates,
  .basisOfRecords_notStandard,
  .summary
)

report <- 
bdc_create_report(
  data = x,
  database_id = "database_id",
  workflow_step = "prefilter",
  save_report = FALSE
)
}