Function reference • nipnTK

Description

nipnTK-package nipnTK: NiPN data quality toolkit

Checking ranges and legal values

outliersUV(): IQR to detect univariate outliers

rl.ex01: Example dataset for checking ranges and legal values

Using scatterplots to identify outliers

outliersMD(): Mahalanobis distance to detect bivariate outliers

sp.ex01: Example dataset for using scatterplots to identify outliers

sp.ex02: Example dataset for using scatterplots to identify outliers

Identifying outliers using flags

national.SMART(): Add SMART flags to a stratified sample survey (e.g. MICS, DHS, national SMART)

flag.ex01: Example dataset for identifying outliers using flags

flag.ex02: Example dataset for identifying outliers using flags

flag.ex03: Example dataset for identifying outliers using flags

Distribution of variable and indices

histNormal(): Histogram with normal curve superimposed to help with “by-eye” assessments of normality of distribution

qqNormalPlot(): Normal quantile-quantile plot

skewKurt(): Skew and kurtosis

print(<skewKurt>): print() helper function for skewKurt() function

dist.ex01: Example dataset for distributions of variables and indices

Digit preference

fullTable(): Fill out a one-dimensional table to include a specified range of values

digitPreference(): Digit preference test

plot(<digitPreference>): plot() helper function for digitPreference() function

print(<digitPreference>): print() helper function for digitPreference() function

dp.ex01: Example dataset for digit preference function

Age heaping

ageHeaping(): Age-heaping analysis

plot(<ageHeaping>): plot() helper functions for ageHeaping() functions

print(<ageHeaping>): print() helper functions for ageHeaping() functions

dp.ex02: Example dataset for digit preference function

ah.ex01: Example dataset for age heaping function

Sex ratio

sexRatioTest(): Sex Ratio Test

print(<sexRatioTest>): print() helper function for sexRatioTest() function

dp.ex02: Example dataset for digit preference function

Age and sex distributions

ageChildren(): Goodness of fit to an expected model-based age distribution

plot(<ageChildren>): Plot helper function for ageChildren() function

print(<ageChildren>): print() helper function for ageChildren() function

ageRatioTest(): Age ratio test

print(<ageRatioTest>): print() helper function for ageRatioTest() function

sexRatioTest(): Sex Ratio Test

pyramid.plot(): Pyramid plot function for creating population pyramids.

as.ex01: Example dataset for age and sex distributions function

as.ex02: Example dataset for age and sex distributions function

dp.ex02: Example dataset for digit preference function

dp.ex03: Example dataset for digit preference

Utility

boxText(): Plot text in a coloured bounding box.

greensIndex(): Green's Index of Dispersion

print(<greensIndex>): print() helper function for print.greensIndex() function