Learn R Programming
⚠️There's a newer version (3.4.3) of this package.Take me there.

Rlabkey (version 2.2.4)

Data Exchange Between R and 'LabKey' Server

Description

The 'LabKey' client library for R makes it easy for R users to load live data from a 'LabKey' Server, , into the R environment for analysis, provided users have permissions to read the data. It also enables R users to insert, update, and delete records stored on a 'LabKey' Server, provided they have appropriate permissions to do so.

Copy Link

Version

Install

install.packages('Rlabkey')

Monthly Downloads

964

Version

2.2.4

License

Apache License 2.0

Maintainer

Cory Nathe

Last Published

November 5th, 2018

Functions in Rlabkey (2.2.4)

getSchema

Returns an object representing a LabKey schema
labkey.rstudio.isInitialized

Check valid rlabkey session
labkey.rstudio.saveReport

Update RStudio report source back to LabKey
labkey.domain.save

Updates an existing LabKey domain
labkey.getDefaultViewDetails

Retrieve the fields of a LabKey query view
labkey.getFolders

Retrieve a list of folders accessible to the current user
labkey.domain.create

Create a new LabKey domain
labkey.domain.createAndLoad

Create a new LabKey domain and load data
labkey.domain.get

Returns the metadata for an existing LabKey domain
labkey.experiment.SAMPLE_DERIVATION_PROTOCOL

Constant for the Simple Derivation Protocol
labkey.setCurlOptions

Modify the current set of Curl options that are being used in the existing session
labkey.experiment.createMaterial

Create an experiment material object
labkey.experiment.createData

Create an experiment data object
labkey.executeSql

Retrieve data from a LabKey Server using SQL commands
labkey.domain.inferFields

Infer field metadata from a data frame
labkey.experiment.saveBatch

Saves a modified experiment batch
labkey.getBaseUrl

Get the default baseUrl parameter used for all http or https requests
labkey.getQueries

Retrieve a list of available queries for a specified LabKey schema
labkey.domain.createDesign

Helper function to create a domain design data structure
labkey.getQueryDetails

Retrieve detailed information on a LabKey query
labkey.rstudio.initReport

Initialize a RStudio session for LabKey R report source editing
labkey.setDebugMode

Helper function to enable/disable debug mode.
labkey.getLookupDetails

Retrieve detailed information on a LabKey query
labkey.experiment.createRun

Create an experiment run object
labkey.getQueryViews

Retrieve a list of available named views defined on a query in a schema
makeFilter

Builds filters to be used in labkey.selectRows and getRows
labkey.rstudio.initSession

Initialize a RStudio session for LabKey integration using a time one request id
labkey.setDefaults

Set the default parameters used for all http or https requests
labkey.domain.drop

Delete a LabKey domain
labkey.updateRows

Update existing rows of data in a labkey database
lsFolders

List the available folder paths
labkey.setModuleProperty

Set module property value
saveResults

Returns an object representing a LabKey schema
labkey.importRows

Import rows of data into a LabKey Server
labkey.getSchemas

Retrieve a list of available schemas from a labkey database
labkey.insertRows

Insert new rows of data into a LabKey Server
labkey.getModuleProperty

Get effective module property value
labkey.transform.getRunPropertyValue

Assay transform script helper function to get a run property value from a data.frame
labkey.transform.readRunPropertiesFile

Assay transform script helper function to read a run properties file
labkey.makeRemotePath

Build a file path to data on a remote machine
lsProjects

List the projects available at a given LabKey Server address
labkey.rstudio.initRStudio

Initialize a RStudio session for LabKey integration
labkey.saveBatch

Save an assay batch object to a labkey database
labkey.selectRows

Retrieve data from a labkey database
lsSchemas

List the available schemas
getFolderPath

Returns the folder path associated with a session
getLookups

Get related data fields that are available to include in a query on a given query object
labkey.curlOptions

Returns the current set of Curl options that are being used in the existing session
labkey.acceptSelfSignedCerts

Convenience method to configure Rlabkey connections to accept self-signed certificates
getSession

Creates and returns a LabKey Server session
labkey.deleteRows

Delete rows of data from a LabKey database
getRows

Retrieve data from LabKey Server
RlabkeyUsersGuide

Open the Rlabkey Users Guide
Rlabkey-package

Exchange data between LabKey Server and R