QAQC: QAQC

View source: R/QAQC.R

QAQCR Documentation

QAQC

Description

Checks template files for data coherence, formatting, and data entry errors

Usage

QAQC(
  file,
  writeQCreport = FALSE,
  outfile_QAQC = "",
  summaryStats = TRUE,
  dataReport = FALSE,
  checkdoi = TRUE,
  verbose = TRUE,
  local = TRUE
)

Arguments

file

File path for template file to be checked

writeQCreport

If TRUE, a text report of the QC output will be written to the outfile. Default is FALSE

outfile_QAQC

Filename of the output file (if writeQCreport is TRUE). Default is NULL, with the outfile being written to the directory where the template file is stored and named according to the file being checked.

summaryStats

Prints summary statistics. Default is TRUE.

dataReport

Prints list structure of database. Default is FALSE.

checkdoi

Set to FALSE if you do not want the QAQC check to validate DOIs (if TRUE this will be time consuming). Default is TRUE.

verbose

Set to TRUE to print results of function to console. Default is TRUE.

local

Set to FALSE to fetch most up-to-date template and template info files. If TRUE, the local files or files from CRAN package will be used. Default is TRUE.

Details

This function can also be called from the ISRaD website.

Examples


# Load example dataset Gaudinski_2001
entry <- ISRaD::Gaudinski_2001
# Save as .xlsx file
ISRaD.save.entry(
  entry = entry,
  template_file = system.file("extdata", "ISRaD_Master_Template.xlsx", package = "ISRaD"),
  outfile = file.path(tempdir(), "Gaudinski_2001.xlsx")
)
# Run QAQC
QAQC(file.path(tempdir(), "Gaudinski_2001.xlsx"))



ISRaD documentation built on Sept. 21, 2023, 9:06 a.m.

Related to QAQC in ISRaD...