Class: RDataFrame

RWorker.RDataFrame

Hierarchy

• RList

  ↳ RDataFrame

Table of contents

Constructors

• constructor

Properties

• ptr

Accessors

• [toStringTag]
• length

Methods

• attrs
• entries
• get
• getDollar
• includes
• inspect
• isDataFrame
• isNa
• isNull
• isUnbound
• names
• pluck
• set
• setNames
• subset
• toArray
• toD3
• toJs
• toObject
• type
• fromD3
• fromObject
• wrap

Constructors

constructor

• new RDataFrame(val): RDataFrame

Parameters

Name	Type
val	WebRData

Returns

RDataFrame

Overrides

RList.constructor

Defined in

webR/robj-worker.ts:707

Properties

ptr

• ptr: number

Inherited from

RList.ptr

Defined in

webR/robj-worker.ts:177

Accessors

[toStringTag]

• get [toStringTag](): string

Returns

string

Inherited from

RList.[toStringTag]

Defined in

webR/robj-worker.ts:206

---

length

• get length(): number

Returns

number

Inherited from

RList.length

Defined in

webR/robj-worker.ts:636

Methods

attrs

▸ attrs(): Nullable<RPairlist>

Returns

Nullable<RPairlist>

Inherited from

RList.attrs

Defined in

webR/robj-worker.ts:242

---

entries

▸ entries(options?): NamedEntries<WebRData>

Parameters

Name	Type
options	Object
options.depth	number

Returns

NamedEntries<WebRData>

Inherited from

RList.entries

Defined in

webR/robj-worker.ts:680

---

get

▸ get(prop): RObject

Parameters

Name	Type
prop	string | number

Returns

RObject

Inherited from

RList.get

Defined in

webR/robj-worker.ts:285

---

getDollar

▸ getDollar(prop): RObject

Parameters

Name	Type
prop	string

Returns

RObject

Inherited from

RList.getDollar

Defined in

webR/robj-worker.ts:289

---

includes

▸ includes(name): null | boolean

Parameters

Name	Type
name	string

Returns

null | boolean

Inherited from

RList.includes

Defined in

webR/robj-worker.ts:271

---

inspect

▸ inspect(): void

Returns

void

Inherited from

RList.inspect

Defined in

webR/robj-worker.ts:220

---

isDataFrame

▸ isDataFrame(): boolean

Returns

boolean

Inherited from

RList.isDataFrame

Defined in

webR/robj-worker.ts:640

---

isNa

▸ isNa(): boolean

Returns

boolean

Inherited from

RList.isNa

Defined in

webR/robj-worker.ts:228

---

isNull

▸ isNull(): this is RNull

Returns

this is RNull

Inherited from

RList.isNull

Defined in

webR/robj-worker.ts:224

---

isUnbound

▸ isUnbound(): boolean

Returns

boolean

Inherited from

RList.isUnbound

Defined in

webR/robj-worker.ts:238

---

names

▸ names(): null | (null | string)[]

Returns

null | (null | string)[]

Inherited from

RList.names

Defined in

webR/robj-worker.ts:262

---

pluck

▸ pluck(...path): undefined | RObject

Parameters

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

Returns

undefined | RObject

Inherited from

RList.pluck

Defined in

webR/robj-worker.ts:309

---

set

▸ set(prop, value): RObject

Parameters

Name	Type
prop	string | number
value	RObject | WebRDataRaw

Returns

RObject

Inherited from

RList.set

Defined in

webR/robj-worker.ts:325

---

setNames

▸ setNames(values): this

Parameters

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

Returns

this

Inherited from

RList.setNames

Defined in

webR/robj-worker.ts:246

---

subset

▸ subset(prop): RObject

Parameters

Name	Type
prop	string | number

Returns

RObject

Inherited from

RList.subset

Defined in

webR/robj-worker.ts:281

---

toArray

▸ toArray(options?): WebRData[]

Parameters

Name	Type
options	Object
options.depth	number

Returns

WebRData[]

Inherited from

RList.toArray

Defined in

webR/robj-worker.ts:645

---

toD3

▸ toD3(): NamedObject<WebRData>[]

Returns

NamedObject<WebRData>[]

Inherited from

RList.toD3

Defined in

webR/robj-worker.ts:667

---

toJs

▸ toJs(options?, depth?): WebRDataJsNode

Parameters

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

Returns

WebRDataJsNode

Inherited from

RList.toJs

Defined in

webR/robj-worker.ts:691

---

toObject

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

Parameters

Name	Type	Default value
«destructured»	Object	{}
› allowDuplicateKey	undefined | boolean	true
› allowEmptyKey	undefined | boolean	false
› depth	undefined | number	-1

Returns

NamedObject<WebRData>

Inherited from

RList.toObject

Defined in

webR/robj-worker.ts:649

---

type

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

Returns

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

Inherited from

RList.type

Defined in

webR/robj-worker.ts:182

---

fromD3

▸ fromD3(arr): RDataFrame

Parameters

Name	Type
arr	{ [key: string]: WebRData; }[]

Returns

RDataFrame

Defined in

webR/robj-worker.ts:758

---

fromObject

▸ fromObject(obj): RDataFrame

Parameters

Name	Type
obj	WebRData

Returns

RDataFrame

Defined in

webR/robj-worker.ts:718

---

wrap

▸ 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

RList.wrap

Defined in

webR/robj-worker.ts:200