processArgs: Argument Processors for 'scoreScale' Function

In raybaser/PROscorerTools: Tools to Score Patient-Reported Outcome (PRO) and Other Psychometric Measures

Argument Processors for scoreScale Function

Description

Functions that are used internally within other PROscorerTools functions, namely scoreScale, to process the arguments passed to them. Only developers wishing to contribute to the PROscorerTools package should use these functions. Even developers should avoid using them for anything but experimentation. If you use these functions, be warned that they will likely change in future versions of the package in ways that may not be compatible with your usage. They will also be made invisible to users in future version of the PROscorerTools package. The only reason they are visible to users in these initial versions of the package is to make the internals of the package more transparent to potential developers to facilitate the development and improvement of the package.

Usage

chkstop_df(df)

chkstop_okmiss(okmiss)

chkstop_type(type, minmax)

chkstop_revitems(df, dfItems, revitems, items, minmax)

chk_imin(dfItems, imin)

chk_imax(dfItems, imax)

chkstop_minmax(dfItems, minmax)

Arguments

df	A data frame, such as the one given scoreScale
okmiss	Proportion of missing items allows, given as argument to scoreScale
type	Score type, given as argument to scoreScale
minmax	Minimum and maximum possible item values, given as argument to scoreScale
dfItems	A data frame with only items, created and used by scoreScale as an interim step in scoring a scale
revitems	Items to reverse, given as argument to scoreScale
items	Item index, given as argument to scoreScale
imin	Minimum possible item value
imax	Maximum possible item value

Details

Functions with prefix chk_ simply check the argument and return TRUE if the argument is OK, or FALSE if the argument fails the check. Functions with the prefix chkstop_ check the argument and, if FALSE, stop execution and display an error message to help the user pinpoint the problem.

Value

Functions with prefix chk_ return TRUE if the argument is OK, or FALSE if the argument fails the check. Functions with the prefix chkstop_ print an error message and stop the execution of the function in which they are embedded.

raybaser/PROscorerTools documentation built on Oct. 17, 2023, 8:48 p.m.