Package 'icesDatsuQC'

Title: Run Quality Checks on Data Prior to Submission to ICES
Description: Run quality checks on data sets using the same checks that are conducted on the ICES Data Submission Utility (DATSU) <https://datsu.ices.dk/web/index.aspx>.
Authors: Colin Millar [aut, cre]
Maintainer: Colin Millar <[email protected]>
License: GPL (>= 2)
Version: 1.1.0
Built: 2024-09-12 05:00:03 UTC
Source: https://github.com/ices-tools-prod/icesDatsuQC

Help Index


Runs quality checks on a dataset

Description

Check a data set against the ICES DATSU data submission utility, the user must supply a dataset version and record type.

Usage

runQCChecks(filename, datasetverID, recordType)

Arguments

filename

the filename of the file to check

datasetverID

the dataset ID

recordType

string name of the record type

Value

The list of check failures

Examples

filename <- system.file("test_files/vms_test.csv", package = "icesDatsuQC")
runQCChecks(filename, 145, "VE")

Runs vocabulary checks on a dataset

Description

Check vocabularies in a data set against the ICES DATSU data submission utility, the user must supply a dataset version and record type.

Usage

runVocabChecks(filename, datasetverID, recordType)

Arguments

filename

the filename of the file to check

datasetverID

the dataset ID

recordType

string name of the record type

Value

The list of vocabulary errors. Every line that failed is reported for each field.

Examples

filename <- system.file("test_files/vms_test.csv", package = "icesDatsuQC")
vc <- runVocabChecks(filename, 145, "VE")
if (length(vc) > 0) {
  library(icesDatsu)
  data <-
    read.csv(
      filename,
      header = FALSE,
      col.names = getDataFieldsDescription(145, "VE")$fieldcode
  )
  # some invalid entries
  data[vc[[1]], names(vc)[1]]
}