getFolderPath: Returns the folder path associated with a session

View source: R/schemaObjects.R

getFolderPathR Documentation

Returns the folder path associated with a session

Description

Returns the current folder path for a LabKey session

Usage

getFolderPath(session) 

Arguments

session

the session key returned from getSession

Details

Returns a string containing the current folder path for the passed in LabKey session

Value

A character array containing the folder path, relative to the root.

Author(s)

Peter Hussey

References

https://www.labkey.org/Documentation/wiki-page.view?name=projects

See Also

getSession lsFolders

Examples

## Not run: 

# library(Rlabkey)

lks<- getSession("https://www.labkey.org", "/home")
getFolderPath(lks)  #returns "/home"


## End(Not run)

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