util_expect_data_frame

stops with an error, if not. will add the columns, and return the resulting
extended data frame, and also updating the original data frame in the
calling environment, if #' <code>x</code> is empty (data frames easily break to
0-columns in R, if they have not rows, e.g. using some <code>split</code>/<code>rbind</code>
pattern)

Data quality assessments guided by a
'data quality framework introduced by Schmidt and colleagues, 2021'
<doi:10.1186/s12874-021-01252-7> target the
data quality dimensions integrity, completeness, consistency, and
accuracy. The scope of applicable functions rests on the
availability of extensive metadata which can be provided in
spreadsheet tables. Either standardized (e.g. as 'html5' reports) or
individually tailored reports can be generated. For an introduction
into the specification of corresponding metadata, please refer to the
'package website'
<https://dataquality.qihs.uni-greifswald.de/Annotation_of_Metadata.html>.

Stephan Struckmann

dataquieR

Data Quality in Epidemiological Research

University Medicine Greifswald 

Elisa Kasbohm

Joany Marino

Adrian Richter

Carsten Oliver Schmidt

German Research Foundation (DFG SCHM 2744/3-1, SCHM 2744/9-1, SCHM 2744/3-4) 

National Research Data Infrastructure for Personal Health Data: (NFDI 13/1) 

European Union’s Horizon 2020 programme (euCanSHare, grant agreement No. 825903) 

util_expect_data_frame function

<dl><dt>x</dt>
<dd>an object that is verified to be a <code>data.frame</code>.</dd>
<dt>col_names</dt>
<dd>column names x must contain or named list of predicates to
check the columns (e.g.,
list(AGE=is.numeric, SEX=is.character))</dd>
<dt>convert_if_possible</dt>
<dd>if given, for each column, a lambda can be given
similar to <code>col_names</code> check functions. This
lambda would be used to try a conversion. If
a conversion fails (returns <code>NA</code>, where the
input was not `util_empty'), an error
is still thrown, the data is converted, otherwise</dd>
<dt>dont_assign</dt>
<dd>set <code>TRUE</code> to keep <code>x</code> in the caller environment untouched</dd></dl>

Arguments

Verify, that argument is a data frame — util_expect_data_frame

<dl>

<dt>x</dt>
<dd>an object that is verified to be a <code>data.frame</code>.</dd>


<dt>col_names</dt>
<dd>column names x must contain or named list of predicates to
check the columns (e.g.,
list(AGE=is.numeric, SEX=is.character))</dd>


<dt>convert_if_possible</dt>
<dd>if given, for each column, a lambda can be given
similar to <code>col_names</code> check functions. This
lambda would be used to try a conversion. If
a conversion fails (returns <code>NA</code>, where the
input was not `util_empty'), an error
is still thrown, the data is converted, otherwise</dd>


<dt>dont_assign</dt>
<dd>set <code>TRUE</code> to keep <code>x</code> in the caller environment untouched</dd>

</dl>

Verify, that argument is a data frame

util_expect_data_frame: Verify, that argument is a data frame

Description

Usage

Value

Arguments