labkey.domain.get: Returns the metadata for an existing LabKey domain

In Rlabkey: Data Exchange Between R and 'LabKey' Server

Returns the metadata for an existing LabKey domain

Description

Get the data structure for a domain.

Usage

labkey.domain.get(baseUrl=NULL, folderPath, schemaName, queryName)

Arguments

baseUrl	a string specifying the baseUrlfor the labkey server
folderPath	a string specifying the folderPath
schemaName	a string specifying the name of the schema of the domain
queryName	a string specifying the query name

Details

Returns the domain design of an existing domain. The returned domain design can be used for reporting purposes or it can be modified and used to create a new domain or update the domain source.

Value

A list containing elements describing the domain. The structure is the same as a domain design created by labkey.createDomainDesign

Author(s)

Karl Lum

See Also

labkey.domain.create, labkey.domain.inferFields, labkey.domain.createDesign, labkey.domain.createIndices, labkey.domain.save, labkey.domain.drop

Examples

## Not run: 

## retrieve an existing domain
library(Rlabkey)

labkey.domain.get(baseUrl="http://labkey/", folderPath="home",
    schemaName="lists", queryName="test list")

## End(Not run)

Rlabkey documentation built on Oct. 23, 2024, 5:06 p.m.