labkey.getQueries: Retrieve a list of available queries for a specified LabKey...

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

Retrieve a list of available queries for a specified LabKey schema

Description

Fetch a list of queries available to the current user within in a specified folder context and specified schema

Usage

labkey.getQueries(baseUrl, folderPath, schemaName)

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
schemaName	a string specifying the schema name in which the query object is defined

Details

“Query” is the LabKey term for a data container that acts like a relational table within LabKey Server. Queries include lists, assay data results, user-defined queries, built-in SQL tables in individual modules, and tables or table-like objects in external schemas, For a specific queriable object, the data that is visible depends on the current user's permissions in a given folder. Function arguments identify the location of the server and the folder path.

Value

The available queries are returned as a three-column data frame containing one row for each field for each query in the specified schema. The three columns are

queryName

the name of the query object, repeated once for every field defined as output of the query.

fieldName

the name of a query output field

caption

the caption of the named field as shown in the column header of a data grid, also known as a label

Author(s)

Peter Hussey, [e-mail]

References

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

See Also

labkey.selectRows, makeFilter, labkey.executeSql, labkey.updateRows, labkey.insertRows, labkey.importRows, labkey.deleteRows, labkey.getSchemas, labkey.getQueryViews, labkey.getQueryDetails, labkey.getDefaultViewDetails, labkey.getLookupDetails

Examples

## Not run: 

## List of queries in a schema
# library(Rlabkey)

queriesDF <- labkey.getQueries(
	baseUrl="https://www.labkey.org",
	folderPath="/home",
	schemaName="lists"
)
queriesDF


## End(Not run)

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