read_qc_mapping {qualitycontrol}R Documentation

Read Quality Control mapping file

Description

read_qc_mapping reads an .xlsx file that contains the QC mapping.

Usage

read_qc_mapping(path)

Arguments

path

excel file path to be read. Each tab should contain 3 tabs with the names missing, inconsistencies and range. Each tab will correspond to one QC mapping table.

QC mapping excel file should contain 3 tabs:

  • missing: columns should be named as "qc_type", "variable" and 'type".

  • inconsistencies: columns should be named as "qc_type", "variable1", "type1", "relation", "variable2" and "type2".

  • range: columns should be named as "qc_type", "variable", "type", "lower_value", "upper_value" and "categories".

The columns specified above should contain specific values:

  • qc_type: "missing", "duplicated", "inconsistent_values" and "range"

  • variable, variable1, variable2: variable name that is included in data.

  • type, type1, type2: "numeric", text", "categorical", "date"

  • relation: expected relation between variable1 and variable2 which can be "greater_than", "greater_than_or_equal", "lower_than", "lower_than_or_equal" or "equal".

  • lower_value, upper_value: expected numeric values representing ranges

  • categories: expected variable categories

Value

A list containing all the QC mapping tables


[Package qualitycontrol version 0.1.0 Index]