is_valueType: Test if a character object is one of the valid valueType...
In madshapR: Support Technical Processes Following 'Maelstrom Research' Standards
is_valueType R Documentation
Test if a character object is one of the valid valueType values
Description
Confirms whether the input object is a valid valueType. This function mainly
helps validate input within other functions of the package but could be used
to check if a valueType is valid.
Usage
is_valueType(object)
Arguments
object
A potential valueType name to be evaluated.
Details
The valueType is a declared property of a variable that is required in
certain functions to determine handling of the variables. Specifically,
valueType refers to the
OBiBa data type of a variable.
The valueType is specified in a data dictionary in a column 'valueType' and
can be associated with variables as attributes. Acceptable valueTypes
include 'text', 'integer', 'decimal', 'boolean', datetime', 'date'. The full
list of OBiBa valueType possibilities and their correspondence with R data
types are available using valueType_list. The valueType can be used to
coerce the variable to the corresponding data type.
Value
A logical.
See Also
Examples
{
is_valueType('integer')
is_valueType('integre')
}
madshapR documentation built on May 29, 2024, 7:43 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| is_valueType | R Documentation |
Test if a character object is one of the valid valueType values
Description
Confirms whether the input object is a valid valueType. This function mainly helps validate input within other functions of the package but could be used to check if a valueType is valid.
Usage
is_valueType(object)
Arguments
object |
A potential valueType name to be evaluated. |
Details
The valueType is a declared property of a variable that is required in certain functions to determine handling of the variables. Specifically, valueType refers to the OBiBa data type of a variable. The valueType is specified in a data dictionary in a column 'valueType' and can be associated with variables as attributes. Acceptable valueTypes include 'text', 'integer', 'decimal', 'boolean', datetime', 'date'. The full list of OBiBa valueType possibilities and their correspondence with R data types are available using valueType_list. The valueType can be used to coerce the variable to the corresponding data type.
Value
A logical.
See Also
Examples
{
is_valueType('integer')
is_valueType('integre')
}
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.