Class: REnvironment

RWorker.REnvironment

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new REnvironment(val?)

Parameters

Name Type
val WebRData

Overrides

RObject.constructor

Defined in

webR/robj-worker.ts:643

Properties

ptr

ptr: number

Inherited from

RObject.ptr

Defined in

webR/robj-worker.ts:141

Accessors

[toStringTag]

get [toStringTag](): string

Returns

string

Inherited from

RObject.__@toStringTag@170

Defined in

webR/robj-worker.ts:169

Methods

attrs

attrs(): Nullable<RPairlist>

Returns

Nullable<RPairlist>

Inherited from

RObject.attrs

Defined in

webR/robj-worker.ts:195


bind

bind(name, value): void

Parameters

Name Type
name string
value WebRData

Returns

void

Defined in

webR/robj-worker.ts:683


frame

frame(): RObject

Returns

RObject

Defined in

webR/robj-worker.ts:698


get

get(prop): RObject

Parameters

Name Type
prop string | number

Returns

RObject

Inherited from

RObject.get

Defined in

webR/robj-worker.ts:237


getDollar

getDollar(prop): RObject

Parameters

Name Type
prop string

Returns

RObject

Inherited from

RObject.getDollar

Defined in

webR/robj-worker.ts:241


includes

includes(name): null | boolean

Parameters

Name Type
name string

Returns

null | boolean

Inherited from

RObject.includes

Defined in

webR/robj-worker.ts:224


inspect

inspect(): void

Returns

void

Inherited from

RObject.inspect

Defined in

webR/robj-worker.ts:183


isNull

isNull(): this is RNull

Returns

this is RNull

Inherited from

RObject.isNull

Defined in

webR/robj-worker.ts:187


isUnbound

isUnbound(): boolean

Returns

boolean

Inherited from

RObject.isUnbound

Defined in

webR/robj-worker.ts:191


ls

ls(all?, sorted?): string[]

Parameters

Name Type Default value
all boolean false
sorted boolean true

Returns

string[]

Defined in

webR/robj-worker.ts:678


names

names(): string[]

Returns

string[]

Overrides

RObject.names

Defined in

webR/robj-worker.ts:694


pluck

pluck(...path): undefined | RObject

Parameters

Name Type
...path (string | number)[]

Returns

undefined | RObject

Inherited from

RObject.pluck

Defined in

webR/robj-worker.ts:261


set

set(prop, value): RObject

Parameters

Name Type
prop string | number
value RObject | WebRDataRaw

Returns

RObject

Inherited from

RObject.set

Defined in

webR/robj-worker.ts:277


setNames

setNames(values): REnvironment

Parameters

Name Type
values null | (null | string)[]

Returns

REnvironment

Inherited from

RObject.setNames

Defined in

webR/robj-worker.ts:199


subset

subset(prop): RObject

Parameters

Name Type
prop string | number

Returns

RObject

Overrides

RObject.subset

Defined in

webR/robj-worker.ts:702


toJs

toJs(options?, depth?): WebRDataJsNode

Parameters

Name Type Default value
options Object undefined
options.depth number undefined
depth number 1

Returns

WebRDataJsNode

Overrides

RObject.toJs

Defined in

webR/robj-worker.ts:718


toObject

toObject(«destructured»?): NamedObject<WebRData>

Parameters

Name Type
«destructured» Object
› depth undefined | number

Returns

NamedObject<WebRData>

Defined in

webR/robj-worker.ts:709


type

type(): "string" | "symbol" | "function" | "double" | "null" | "pairlist" | "closure" | "environment" | "promise" | "call" | "special" | "builtin" | "logical" | "integer" | "complex" | "character" | "dots" | "any" | "list" | "expression" | "bytecode" | "pointer" | "weakref" | "raw" | "s4" | "new" | "free"

Returns

"string" | "symbol" | "function" | "double" | "null" | "pairlist" | "closure" | "environment" | "promise" | "call" | "special" | "builtin" | "logical" | "integer" | "complex" | "character" | "dots" | "any" | "list" | "expression" | "bytecode" | "pointer" | "weakref" | "raw" | "s4" | "new" | "free"

Inherited from

RObject.type

Defined in

webR/robj-worker.ts:146


wrap

Static wrap<T>(this, ptr): InstanceType<T>

Type parameters

Name Type
T extends typeof RObject

Parameters

Name Type
this T
ptr number

Returns

InstanceType<T>

Inherited from

RObject.wrap

Defined in

webR/robj-worker.ts:164