VitessceConfigDatasetFile: VitessceConfigDatasetFile Class

In vitessce/vitessceR: Create Interactive Single-cell Visualizations with the 'Vitessce' JavaScript Library

VitessceConfigDatasetFile Class

Description

Class representing a file in a dataset in a Vitessce view config.

Details

File in a dataset in a VitessceConfig

Methods

Public methods

• VitessceConfigDatasetFile$new()

• VitessceConfigDatasetFile$to_list()

• VitessceConfigDatasetFile$clone()

---

Method new()

Create a new dataset file object.

Usage

VitessceConfigDatasetFile$new(
  url = NA,
  file_type = NA,
  options = NA,
  coordination_values = NA,
  data_type = NA
)

Arguments

url

A URL for the file.

file_type

A file type for the file.

options

A list of options to include for the file.

coordination_values

A list of coordination values to include in the file definition.

data_type

A data type for the file.

Returns

A new VitessceConfigDatasetFile object.

---

Method to_list()

Convert the object to an R list. Helpful when converting the config to JSON.

Usage

VitessceConfigDatasetFile$to_list()

Returns

A list that can be serialized to JSON using rjson.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

VitessceConfigDatasetFile$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

vitessce/vitessceR documentation built on Oct. 12, 2024, 12:24 a.m.