collapse_vector: Collapse a vector of values into a single string when...

View source: R/utilities.R

collapse_vectorR Documentation

Collapse a vector of values into a single string when necessary

Description

REDCap's API frequently specifies a series of values separated by commas. In the R world, it's easier to keep these values as separate elements in a vector. This functions squashes them together in a single character element (presumably right before the return value is passed to the API)

Usage

collapse_vector(elements, collapsed)

Arguments

elements

An array of values. Can be NULL. Required.

collapsed

A single character element, where the values are separated by commas. Can be NULL. Required.

Value

A single character element, where the values are separated by commas. Can be blank. (i.e., "").

Author(s)

Will Beasley

Examples

library(REDCapR) #Load the package into the current R session.
REDCapR:::collapse_vector(elements=NULL, collapsed=NULL)
REDCapR:::collapse_vector(elements=letters, collapsed=NULL)
REDCapR:::collapse_vector(elements=NULL, collapsed="4,5,6")

REDCapR documentation built on Aug. 10, 2022, 5:06 p.m.