util_heatmap_1th

Function to create heatmap-like plot given one threshold -- works for
percentages for now.

internal

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

Elena Salogni

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_heatmap_1th function

<dl><dt>df</dt>
<dd><a href="/link/data.frame?package=dataquieR&version=2.1.0" data-mini-rdoc="dataquieR::data.frame">data.frame</a> with data to display as a heatmap.</dd>
<dt>cat_vars</dt>
<dd>variable list len=1-2. Variables to group by. Up to 2
group levels supported.</dd>
<dt>values</dt>
<dd>variable the name of the percentage variable</dd>
<dt>threshold</dt>
<dd><a href="/link/numeric?package=dataquieR&version=2.1.0" data-mini-rdoc="dataquieR::numeric">numeric</a> lowest acceptable value</dd>
<dt>right_intv</dt>
<dd><a href="/link/logical?package=dataquieR&version=2.1.0" data-mini-rdoc="dataquieR::logical">logical</a> len=1. If <code>FALSE</code> (default), intervals used
to define color ranges in the heatmap
are closed on the left side, if <code>TRUE</code> on
the right side, respectively.</dd>
<dt>invert</dt>
<dd><a href="/link/logical?package=dataquieR&version=2.1.0" data-mini-rdoc="dataquieR::logical">logical</a> len=1. If <code>TRUE</code>, high values are better, warning
colors are used for low values. <code>FALSE</code> works
vice versa.</dd>
<dt>cols</dt>
<dd>deprecated, ignored.</dd>
<dt>strata</dt>
<dd>variable optional, the name of a variable
used for stratification
<code>inheritParams</code> <code>acc_distributions</code></dd></dl>

Arguments

Utility Function Heatmap with 1 Threshold — util_heatmap_1th

<dl>

<dt>df</dt>
<dd><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a> with data to display as a heatmap.</dd>


<dt>cat_vars</dt>
<dd>variable list len=1-2. Variables to group by. Up to 2
group levels supported.</dd>


<dt>values</dt>
<dd>variable the name of the percentage variable</dd>


<dt>threshold</dt>
<dd><a href='https://rdrr.io/r/base/numeric.html'>numeric</a> lowest acceptable value</dd>


<dt>right_intv</dt>
<dd><a href='https://rdrr.io/r/base/logical.html'>logical</a> len=1. If <code>FALSE</code> (default), intervals used
to define color ranges in the heatmap
are closed on the left side, if <code>TRUE</code> on
the right side, respectively.</dd>


<dt>invert</dt>
<dd><a href='https://rdrr.io/r/base/logical.html'>logical</a> len=1. If <code>TRUE</code>, high values are better, warning
colors are used for low values. <code>FALSE</code> works
vice versa.</dd>


<dt>cols</dt>
<dd>deprecated, ignored.</dd>


<dt>strata</dt>
<dd>variable optional, the name of a variable
used for stratification
<code>inheritParams</code> <code>acc_distributions</code></dd>

</dl>

Utility Function Heatmap with 1 Threshold

util_heatmap_1th: Utility Function Heatmap with 1 Threshold

Description

Usage

Value

Arguments

See Also