Learn R Programming

⚠️There's a newer version (3.3.0) of this package.Take me there.

Rlabkey (version 2.8.0)

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

1,298

Version

2.8.0

License

Apache License 2.0

Maintainer

Last Published

July 8th, 2021

Functions in Rlabkey (2.8.0)

getRows

Retrieve data from LabKey Server
Rlabkey-package

Exchange data between LabKey Server and R
getFolderPath

Returns the folder path associated with a session
getSession

Creates and returns a LabKey Server session
labkey.acceptSelfSignedCerts

Convenience method to configure Rlabkey connections to accept self-signed certificates
labkey.curlOptions

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

Delete rows of data from a LabKey database
getSchema

Returns an object representing a LabKey schema
RlabkeyUsersGuide

Open the Rlabkey Users Guide
getLookups

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

Returns the metadata for an existing LabKey domain
labkey.domain.createAndLoad

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

Delete a LabKey domain
labkey.domain.createConditionalFormatQueryFilter

Create a conditional format query filter
labkey.domain.createIndices

Helper function to create a domain design indices list
labkey.experiment.createRun

Create an experiment run object
labkey.experiment.createMaterial

Create an experiment material object
labkey.experiment.saveBatch

Saves a modified experiment batch
labkey.domain.save

Updates an existing LabKey domain
labkey.importRows

Import rows of data into a LabKey Server
labkey.domain.inferFields

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

Saves Runs.
labkey.executeSql

Retrieve data from a LabKey Server using SQL commands
labkey.getRequestOptions

Helper function to get the HTTP request options for a specific method type.
labkey.insertRows

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

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

Get effective module property value
labkey.domain.createConditionalFormat

Create a conditional format data frame
labkey.pipeline.getProtocols

Gets the protocols that have been saved for a particular pipeline
labkey.rstudio.isInitialized

Check valid rlabkey session
labkey.rstudio.initSession

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

Gets the container in which the pipeline is defined
labkey.rstudio.initRStudio

Initialize a RStudio session for LabKey integration
labkey.rstudio.initReport

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

Create provenance parameter object
labkey.provenance.startRecording

Start a provenance recording
labkey.domain.createDesign

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

Retrieve data from a labkey database
labkey.setDefaults

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

Retrieve detailed information on a LabKey query
labkey.setDebugMode

Helper function to enable/disable debug mode.
labkey.webdav.downloadFolder

Recursively download a folder via WebDAV
labkey.getBaseUrl

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

Retrieve the fields of a LabKey query view
labkey.security.createContainer

Creates a new container, which may be a project, folder, or workbook, on the server
labkey.setCurlOptions

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

Tests if a path exists on a LabKey Server via WebDAV
labkey.webdav.mkDirs

Create a folder via WebDAV
labkey.setModuleProperty

Set module property value
labkey.webdav.put

Upload a file via WebDAV
labkey.security.getContainers

Returns information about the specified container
labkey.transform.getRunPropertyValue

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

Start impersonating a user
labkey.webdav.get

Download a file via WebDAV
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.makeRemotePath

Build a file path to data on a remote machine
labkey.getQueries

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

Provide comparator access
labkey.getFolders

Retrieve a list of folders accessible to the current user
labkey.pipeline.startAnalysis

Start an analysis of a set of files using a pipeline
labkey.getLookupDetails

Retrieve detailed information on a LabKey query
labkey.whoAmI

Call the whoami API
labkey.security.moveContainer

Moves an existing container, which may be a folder or workbook
saveResults

Returns an object representing a LabKey schema
labkey.security.stopImpersonating

Stop impersonating a user
labkey.pipeline.getFileStatus

Gets the protocol file status for a pipeline
labkey.query.import

Bulk import an R data frame into a LabKey Server table using file import.
labkey.experiment.SAMPLE_DERIVATION_PROTOCOL

Constant for the Simple Derivation Protocol
labkey.domain.create

Create a new LabKey domain
labkey.rstudio.saveReport

Update RStudio report source back to LabKey
labkey.experiment.createData

Create an experiment data object
labkey.provenance.addRecordingStep

Add a step to a provenance recording
lsSchemas

List the available schemas
labkey.provenance.stopRecording

Stop a provenance recording
labkey.webdav.listDir

List the contents of a LabKey Server folder via WebDAV
labkey.saveBatch

Save an assay batch object to a labkey database
labkey.security.deleteContainer

Deletes an existing container, which may be a project, folder, or workbook
labkey.transform.readRunPropertiesFile

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

Delete all rows from a table
labkey.updateRows

Update existing rows of data in a labkey database
lsFolders

List the available folder paths
lsProjects

List the projects available at a given LabKey Server address
labkey.webdav.mkDir

Create a folder via WebDAV
labkey.webdav.delete

Deletes the provided file/folder on a LabKey Server via WebDAV