Rlabkey (version 2.2.4)

labkey.getSchemas: Retrieve a list of available schemas from a labkey database

Description

Fetch a list of schemas available to the current user in a specified folder context

Usage

labkey.getSchemas(baseUrl, folderPath)

Arguments

baseUrl

a string specifying the address of the LabKey Server, including the context root

folderPath

a string specifying the hierarchy of folders to the current folder (container) for the operation, starting with the project folder

Value

The available schemas are returned as a single-column data frame.

Details

Schemas act as the name space for query objects in LabKey Server. Schemas are generatlly associated with a LabKey Server "module" that provides some specific functionality. Within a queriable object, the specific data that is visible depends on the current user's permissions in a given folder. Function arguments are the components of the url that identify the location of the server and the folder path.

References

http://www.omegahat.net/RCurl/, https://www.labkey.org/project/home/begin.view

See Also

Retrieve data: labkey.selectRows, makeFilter, labkey.executeSql Modify data: labkey.updateRows, labkey.insertRows, labkey.importRows, labkey.deleteRows List available data: labkey.getQueries, labkey.getQueryViews, labkey.getQueryDetails, labkey.getDefaultViewDetails, labkey.getLookupDetails,

Examples

# NOT RUN {
## List of schemas
# library(Rlabkey)

schemasDF <- labkey.getSchemas(
	baseUrl="http://localhost:8080/labkey",
	folderPath="/apisamples"
)

# }