byName: Resource By Name

In primitybio/cellengine-r-toolkit: 'CellEngine' API Toolkit

Resource By Name

Description

Allows specifying a resource by name instead of by id, anywhere that an id is accepted.

Usage

byName(name)

Arguments

name	Name of resource.

Details

Internally, this looks up the resource's id by name before the function runs. To improve performance, the resource's id is cached for the duration of the R session. Resources such as gates that exist within an experiment are cached within the experiment's scope. That is, the following is safe, even though the FCS files have the same name:

getFcsFile(byName("experiment 1"), byName("fcsfile1.fcs")) getFcsFile(byName("experiment 2"), byName("fcsfile1.fcs"))

Examples

## Not run: 
getGates(byName("my experiment"))
getGates(experimentId = byName("my experiment"))

## End(Not run)

primitybio/cellengine-r-toolkit documentation built on Oct. 19, 2024, 1:17 a.m.