odataCleanName: odataCleanName - converts names to ODATA compliant version....

In AmundsenJunior/pfsrsdk: Functions for interacting with Platform for Science APIs

Description

odataCleanName - converts names to ODATA compliant version. Used to clean names in ODATA calls.

Usage

odataCleanName(name, refType = "odataObject")

Arguments

name	string to clean
refType	Reference to the type of object being passed (default: odataObject).

Details

odataCleanName Clean a name for ODATA.

Value

Returns name in ODATA compliant form

Using refType parameter

refType accepts two values, the default "odataObject" and "tenant". "odataObject" ensures that a leading underscore is placed in front of numbers at the beginning of the string to comply with OData Standards. This function can be used for other objects as well to replace spaces and hyphens with underscores. When refType is set to "tenant", underscores are substituted for spaces, but leaves hyphens intact.

Author(s)

Craig Parman [e-mail]

Adam Wheeler [e-mail]

Scott Russell [e-mail]

Examples

## Not run: 
new_name <- odataCleanName("384 Well Plate")
# returns "_384_WELL_PLATE"
new_name <- odataCleanName("384 Well Plate", "tenant")
# returns "384_WELL_PLATE"

## End(Not run)

AmundsenJunior/pfsrsdk documentation built on July 18, 2019, 8:10 p.m.