attributeAssignment: Helper Functions for 'exportRecordsType' Attributes

In redcapAPI: Interface to 'REDCap'

Helper Functions for exportRecordsType Attributes

Description

These functions assist in setting attributes for columns of the resulting type cast data.frame.

Usage

stripHTMLandUnicode(field_name, field_label, field_annotation)

unitsFieldAnnotation(field_name, field_label, field_annotation)

Arguments

field_name	character. Name of the fields.
field_label	character. Labels from meta data.
field_annotation	character. Annotations from meta_data.

Details

Functions passed into the assignment argument list of exportRecordsTyped() construct attributes on a column. They are expected to have a signature of ⁠function(field_name, field_label, field_annotation)⁠ and return the attribute to assign or NA. They must be vectorized.

Useful utilities are provided in stringCleanup()

stripHTMLandUnicode strips both HTML and UNICODE from the field_label.

unitsFieldAnnotation pulls a units string from the field_annotation. An example of the form searched for is ⁠units=\{"meters"\}⁠

Value

stripHTMLandUnicode returns a character vector.

unitsFieldAnnotation returns a character vector.

See Also

exportRecordsTyped(),
exportReportsTyped(),
stripHTMLTags(),
stripUnicode()

Examples

## Not run: 
stripHTMLandUnicode("field_name", "<b>Field label</b>", "field annotation")

unitsFieldAnnotation("field", "label", "units={\"meters\"}")

## End(Not run)

redcapAPI documentation built on June 8, 2025, 1:49 p.m.