labkey.rstudio.initReport: Initialize a RStudio session for LabKey R report source...

View source: R/labkey.rstudio.R

labkey.rstudio.initReportR Documentation

Initialize a RStudio session for LabKey R report source editing

Description

LabKey-RStudio integration helper. Not intended for use outside RStudio.

Usage

labkey.rstudio.initReport(apiKey = "", baseUrl = "", folderPath,
  reportEntityId, skipViewer = FALSE, skipEdit = FALSE)

Arguments

apiKey

session key from your server

baseUrl

server location including context path, if any. e.g. https://www.labkey.org/

folderPath

a string specifying the folderPath

reportEntityId

LabKey report's entityId

skipViewer

(TRUE | FALSE) TRUE to skip setting up LabKey schema viewer in RStudio

skipEdit

(TRUE | FALSE) TRUE to open file in editor

Examples

## Not run: 
## RStudio console only
library(Rlabkey)
labkey.rstudio.initReport(apiKey="abcdef0123456789abcdef0123456789",
    baseUrl="http://labkey/", folderPath="home",
    reportEntityId="0123456a-789b-1000-abcd-01234567abcde")


## End(Not run)

Rlabkey documentation built on Nov. 8, 2023, 1:06 a.m.