read_qc_mapping

<code>read_qc_mapping</code> reads an <code>.xlsx</code> file that contains
the QC mapping.

An easy framework to set a quality control workflow on a dataset.
Includes a various range of functions that allow to establish an adaptable
data quality control.

Luis Garcez

qualitycontrol

Unified Framework for Data Quality Control

read_qc_mapping function

<dl><dt>path</dt>
<dd>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 <code>excel</code> file should contain 3 tabs:<ul>
<li>missing: columns should be named as "qc_type",
"variable" and `type".</li>
<li>inconsistencies: columns should be named as "qc_type",
"variable1", "type1", "relation", "variable2" and "type2".</li>
<li>range: columns should be named as "qc_type",
"variable", "type", "lower_value", "upper_value" and "categories".</li>
</ul></dd>The columns specified above should contain specific values:<ul>
<li>qc_type: "missing", "duplicated", "inconsistent_values" and "range"</li>
<li>variable, variable1, variable2: variable name that is included in data.</li>
<li>type, type1, type2: "numeric", text", "categorical", "date"</li>
<li>relation: expected relation between variable1 and variable2 which can be
"greater_than", "greater_than_or_equal", "lower_than", "lower_than_or_equal" or "equal".</li>
<li>lower_value, upper_value: expected numeric values representing ranges</li>
<li>categories: expected variable categories</li>
</ul></dl>

Arguments

Read Quality Control mapping file — read_qc_mapping

<dl>

<dt>path</dt>
<dd>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 <code>excel</code> file should contain 3 tabs:<ul>
<li>missing: columns should be named as "qc_type",
"variable" and `type".</li>
<li>inconsistencies: columns should be named as "qc_type",
"variable1", "type1", "relation", "variable2" and "type2".</li>
<li>range: columns should be named as "qc_type",
"variable", "type", "lower_value", "upper_value" and "categories".</li>
</ul>

The columns specified above should contain specific values:<ul>
<li>qc_type: "missing", "duplicated", "inconsistent_values" and "range"</li>
<li>variable, variable1, variable2: variable name that is included in data.</li>
<li>type, type1, type2: "numeric", text", "categorical", "date"</li>
<li>relation: expected relation between variable1 and variable2 which can be
"greater_than", "greater_than_or_equal", "lower_than", "lower_than_or_equal" or "equal".</li>
<li>lower_value, upper_value: expected numeric values representing ranges</li>
<li>categories: expected variable categories</li>
</ul></dd>

</dl>

read_qc_mapping: Read Quality Control mapping file

Description

Usage

Value

Arguments