# A Collection of Utilities

## Documentation for package ‘ufs’ version 0.5.12

- DESCRIPTION file.

## Help Pages

A B C D E F G H I K M N O P Q R S T U V W Z misc

## -- A --

aipedjmv | Sample size for accuracy: d
aiperjmv | Sample size for accuracy: r
areColors | Check whether elements of a vector are valid colors
arr | Absolute Relative Risk and confidence interval
as.data.frame.descr | descr (or descriptives)
associationMatrix | associationMatrix
associationMatrixESDefaults | associationMatrix Helper Functions
associationMatrixStatDefaults | associationMatrix Helper Functions
associationsDiamondPlot | A diamondplot with confidence intervals for associations
associationsToDiamondPlotDf | A diamondplot with confidence intervals for associations
attenuate.d | Attenuate a Cohen's d estimate for unreliability in the continuous variable
attenuate.r | Attenuate a Pearson's r estimate for unreliability in the measurements
A_VarghaDelaney | Vargha & Delaney's A

## -- B --

BAC_plot | Bland-Altman Change plot
bfi | 25 Personality items representing 5 factors
bfi-data | 25 Personality items representing 5 factors
biAxisDiamondPlot | Diamondplot with two Y axes
biDimColors | Create colours for a response scale for an item

## -- C --

carelessObject | Compute diagnostics for careless responding
carelessReport | A report to help diagnosing careless responders
cat0 | Concatenate to screen without spaces
checkDataIntegrity | Conveniently checking data integrity
checkPkgs | Check for presence of a package
CIM | Conceptual Independence Matrix
CIM_partial | Conceptual Independence Matrix
cohensdCI | The distribution of Cohen's _d_
cohensDdistribution | The distribution of Cohen's _d_
computeEffectSize_d | associationMatrix Helper Functions
computeEffectSize_etasq | associationMatrix Helper Functions
computeEffectSize_omegasq | associationMatrix Helper Functions
computeEffectSize_r | associationMatrix Helper Functions
computeEffectSize_v | associationMatrix Helper Functions
computeStatistic_chisq | associationMatrix Helper Functions
computeStatistic_f | associationMatrix Helper Functions
computeStatistic_r | associationMatrix Helper Functions
computeStatistic_t | associationMatrix Helper Functions
confIntD | The distribution of Cohen's _d_
confintdjmv | Effect Size Confidence Interval: Cohens's d
confIntOmegaSq | Confidence intervals for Omega Squared
confIntProp | Confidence intervals for proportions, vectorized over all arguments
confIntR | A function to compute a correlation's confidence interval
confintrjmv | Effect Size Confidence Interval: Pearson's r
confIntSD | Confidence interval for standard deviation
confIntV | Cramer's V and its confidence interval
convert | conversion functions
convert.b.to.t | conversion functions
convert.cer.to.d | Helper functions for Numbers Needed for Change
convert.chisq.to.p | conversion functions
convert.chisq.to.V | conversion functions
convert.cohensf.to.omegasq | conversion functions
convert.cohensfsq.to.omegasq | conversion functions
convert.d.to.eer | Helper functions for Numbers Needed for Change
convert.d.to.logodds | conversion functions
convert.d.to.nnc | Helper functions for Numbers Needed for Change
convert.d.to.r | conversion functions
convert.d.to.t | conversion functions
convert.d.to.U3 | Convert Cohen's d to U3
convert.d.to.variance | conversion functions
convert.eer.to.d | Helper functions for Numbers Needed for Change
convert.etasq.to.cohensf | conversion functions
convert.etasq.to.r | conversion functions
convert.f.to.d | conversion functions
convert.f.to.etasq | conversion functions
convert.f.to.omegasq | conversion functions
convert.f.to.p | conversion functions
convert.fisherz.to.r | conversion functions
convert.logodds.to.d | conversion functions
convert.logodds.to.r | conversion functions
convert.means.to.d | conversion functions
convert.ncf.to.omegasq | conversion functions
convert.omegasq.to.cohensf | conversion functions
convert.omegasq.to.cohensfsq | conversion functions
convert.omegasq.to.f | conversion functions
convert.or.to.d | conversion functions
convert.or.to.r | conversion functions
convert.percentage.to.se | conversion functions
convert.r.to.d | conversion functions
convert.r.to.fisherz | conversion functions
convert.r.to.p | conversion functions
convert.r.to.t | conversion functions
convert.t.to.d | conversion functions
convert.t.to.p | conversion functions
convert.t.to.r | conversion functions
convert.V.to.r | conversion functions
convertToNumeric | Conveniently convert vectors to numeric
cramersV | Cramer's V and its confidence interval

## -- D --

dataShape | normalityAssessment and samplingDistribution
dCohensd | The distribution of Cohen's _d_
dd | The distribution of Cohen's _d_
descr | descr (or descriptives)
descr.data.frame | descr (or descriptives)
descr.default | descr (or descriptives)
descriptives | descr (or descriptives)
diamondCoordinates | Basic ggplot2 diamond plot layer construction functions
diamondPlot | Basic diamond plot construction function
disattenuate.d | Disattenuate a Cohen's d estimate for unreliability in the continuous variable
disattenuate.r | Disattentuate a Pearson's r estimate for unreliability
domegaSq | The distribution of Omega Squared
duoComparisonDiamondPlot | meansComparisonDiamondPlot and duoComparisonDiamondPlot

## -- E --

escapeBS | Escapes any characters that would have special meaning in a reqular expression.
escapeRegex | Escapes any characters that would have special meaning in a reqular expression.
exceptionalScore | Find exceptional scores
exceptionalScores | Find exceptional scores
exportToHTML | Exporting tables to HTML
extractVarName | Extract variable names

## -- F --

faConfInt | Extract confidence bounds from psych's factor analysis object
factorLoadingDiamondCIplot | Two-dimensional visualisation of factor analyses
factorLoadingHeatmap | Two-dimensional visualisation of factor analyses
fa_failsafe | Do factor-analysis, logging warnings and errors
findShortestInterval | Find the shortest interval
formatCI | Pretty formatting of confidence intervals
formatPvalue | Pretty formatting of _p_ values
formatR | Pretty formatting of correlation coefficients

## -- G --

get | Options for the ufs package
getDat | Use a dialog to load data from an SPSS file
getData | Use a dialog to load data from an SPSS file
ggBarChart | Bar chart using ggplot
ggBoxplot | Box plot using ggplot
ggDiamondLayer | Basic ggplot2 diamond plot layer construction functions
ggEasyBar | Convenience functions for ggplots based on multiple variables
ggEasyPlots | Convenience functions for ggplots based on multiple variables
ggEasyRidge | Convenience functions for ggplots based on multiple variables
ggPie | A ggplot pie chart
ggProportionPlot | Sample distribution based plotting of proportions
ggqq | Easy ggplot Q-Q plot
ggSave | Save a ggplot with specific defaults
grid.draw.ggProportionPlot | Sample distribution based plotting of proportions

## -- H --

heading | Print a heading

## -- I --

ifelseObj | Conditional returning of an object
insertFigureCaption | Insert numbered caption
insertNumberedCaption | Insert numbered caption
insertTableCaption | Insert numbered caption
invertItem | invertItems
invertItems | invertItems
iqrOutlier | Identify outliers according to the IQR criterion
irpplot | Visualising individual response patterns
is.even | Checking whether numbers are odd or even
is.nr | 'NULL' and 'NA' 'proof' checking of whether something is a number
is.odd | Checking whether numbers are odd or even
isTrue | More flexible version of isTRUE

## -- K --

kblXtra | Wrapper for kableExtra for consistent 'ufs' table styling
knitAndSave | knitAndSave
knitFig | Easily knit a custom figure fragment
knit_print.CIM | Conceptual Independence Matrix
knit_print.scaleDiagnosis | scaleDiagnosis
knit_print.scaleStructure | scaleStructure

## -- M --

makeScales | Title
massConvertToNumeric | Converting many dataframe columns to numeric
meanConfInt | A confidence interval for the mean
meansComparisonDiamondPlot | meansComparisonDiamondPlot and duoComparisonDiamondPlot
meansDiamondPlot | Diamond plots
meansDiamondPlotjmv | Diamond plot: means
meanSDtoDiamondPlot | A diamond plot based on means, standard deviations, and sample sizes
multiResponse | Generate a table for multiple response questions
multiResponsejmv | Multi Response
multiVarFreq | Generate a table collapsing frequencies of multiple variables

## -- N --

normalHist | normalHist
normalityAssessment | normalityAssessment and samplingDistribution
noZero | Remove one or more zeroes before the decimal point

## -- O --

opts | Options for the ufs package

## -- P --

pander.associationMatrix | associationMatrix
pander.dataShape | normalityAssessment and samplingDistribution
pander.descr | descr (or descriptives)
pander.normalityAssessment | normalityAssessment and samplingDistribution
parallelSubscales | Split a dataset into two parallel halves
pCohensd | The distribution of Cohen's _d_
pd | The distribution of Cohen's _d_
pdExtreme | The distribution of Cohen's _d_
pdInterval | The distribution of Cohen's _d_
pdMild | The distribution of Cohen's _d_
pomegaSq | The distribution of Omega Squared
print.associationMatrix | associationMatrix
print.confIntOmegaSq | Confidence intervals for Omega Squared
print.confIntV | Cramer's V and its confidence interval
print.CramersV | Cramer's V and its confidence interval
print.dataShape | normalityAssessment and samplingDistribution
print.descr | descr (or descriptives)
print.ggProportionPlot | Sample distribution based plotting of proportions
print.meanConfInt | A confidence interval for the mean
print.normalHist | normalHist
print.normalityAssessment | normalityAssessment and samplingDistribution
print.parallelSubscales | Split a dataset into two parallel halves
print.pwr.omegasq | Power calculations for Omega Squared.
print.regrInfluential | Detecting influential cases in regression analyses
print.scaleDiagnosis | scaleDiagnosis
print.scaleStructure | scaleStructure
print.scatterMatrix | scatterMatrix
print.testRetestAlpha | Test-Retest Alpha Coefficient
print.testRetestCES | Test-Retest Coefficient of Equivalence & Stability
print.testRetestReliability | testRetestReliability
print.ufsARR | Absolute Relative Risk and confidence interval
pwr.bootES | Estimate required sample size for accuracy in parameter estimation using bootES
pwr.cohensdCI | The distribution of Cohen's _d_
pwr.confIntd | The distribution of Cohen's _d_
pwr.confIntProp | Estimate required sample size for accuracy in parameter estimation of a proportion
pwr.confIntR | Determine required sample size for a given confidence interval width for Pearson's r
pwr.omegasq | Power calculations for Omega Squared.

## -- Q --

qCohensd | The distribution of Cohen's _d_
qd | The distribution of Cohen's _d_
qomegaSq | The distribution of Omega Squared
quietGitLabUpdate | Quietly update a package from a remote repository
quietRemotesInstall | Quietly update a package from a remote repository
qVec | Convenience function to quickly copy-paste a vector
qVecSum | Convenience function to quickly copy-paste a vector

## -- R --

rawDataDiamondLayer | Basic ggplot2 diamond plot layer construction functions
rbind_dfs | Simple alternative for rbind.fill or bind_rows
rbind_df_list | Bind lots of dataframes together rowwise
rCohensd | The distribution of Cohen's _d_
rd | The distribution of Cohen's _d_
regrInfluential | Detecting influential cases in regression analyses
repeatStr | Repeat a string a number of times
report | Output report from results
report.default | Output report from results
repStr | Repeat a string a number of times
reset | Options for the ufs package
romegaSq | The distribution of Omega Squared

## -- S --

safeRequire | Load a package, install if not available
samplingDistribution | normalityAssessment and samplingDistribution
scaleDiagnosis | scaleDiagnosis
scaleDiagnosis_partial | scaleDiagnosis
scaleReliability | scaleStructure
scaleStructure | scaleStructure
scaleStructurePartial | scaleStructure
scaleStructure_partial | scaleStructure
scatterMatrix | scatterMatrix
set | Options for the ufs package
setCaptionNumberingKnitrHook | Set a knitr hook for caption numbering
setFigCapNumbering | Set a knitr hook for caption numbering
setTabCapNumbering | Set a knitr hook for caption numbering
sharedSubString | sharedSubString
simDataSet | Simulate a dataset
spearmanBrown | Spearman-Brown formula
spearmanBrown_requiredLength | Spearman-Brown formula
spearmanBrown_reversed | Spearman-Brown formula
strToFilename | Convert a string to a safe filename
suspectParticipants | Selects suspect participants from a 'carelessObject'

## -- T --

testRetestAlpha | Test-Retest Alpha Coefficient
testRetestCES | Test-Retest Coefficient of Equivalence & Stability
testRetestReliability | testRetestReliability
testRetestSimData | testRetestSimData is a simulated dataframe used to demonstrate the testRetestAlpha coefficient function.

## -- U --

uniDimColors | Create colours for a response scale for an item

## -- V --

varsToDiamondPlotDf | Basic ggplot2 diamond plot layer construction functions
vecTxt | Easily parse a vector into a character value
vecTxtB | Easily parse a vector into a character value
vecTxtM | Easily parse a vector into a character value
vecTxtQ | Easily parse a vector into a character value
viridisPalette | Convenience function to get 2-7 color viridis palettes

## -- W --

wrapVector | Wrap all elements in a vector

## -- Z --

zotero_construct_export_call | Construct the URL for a Zotero export call
zotero_download_and_export_items | Download and save all items in a public Zotero group
zotero_get_all_items | Get all items in a public Zotero group
zotero_nr_of_items | Get number of items in a public Zotero group

## -- misc --

%IN% | Case insensitive version of %in%