EpivizEnvironment-class: Data container for an Epiviz environment component.

Description Fields Methods

Description

Data container for an Epiviz environment component.

Fields

charts

List of class EpivizViewComponent used to track nested elements.

interactive

Logical value of whether componenet is interactive with data source componenet..

epiviz_ds

EpivizDataSource object for interactive documents.

Methods

add_data(...)

Add data to environment's data manager

...

Arguments for add_measurements and register, e.g., data, datasource_name, datasource_obj_name, type, etc

add_genome(genome, type = "gene_info", datasource_name = NULL)

Add a genome to the view, and a genes-track.

genome

annotation object. eg. Homo.sapiens

append_chart(chart)

Append chart or navigation to environment

append_region(chr = NULL, start = NULL, end = NULL, ...)

Add a child Navigation element to the given genomic region

get_charts()

Get charts within environment

get_component_type()

Get component type for prefix of random id generator

get_measurements()

Get measurements

get_name()

Get name of Epiviz Web Component

get_rows(...)

Get row data from environment's data manager

get_values(...)

Get value data from environment's data manager

init_region(chr = NULL, start = NULL, end = NULL)

Initialize navigation based on a genomic region

chr

Chromosome

start

Start location

end

End location

init_regions(regions)

Initialize navigations based on genomic regions

regions

List of named lists of genomic locations, e.g., list(list(chr='chr11', start=99800000, end=103383180))

is_interactive()

Return whether the environment is interactive with a data source

navigate(chr = NULL, start = NULL, end = NULL)

Navigate environment to genomic location

chr

Chromosome

start

Start location

end

End location

order_charts(ordered_charts)

Order the charts within an environment

charts

An ordered list of EpivizViewComponent objects

plot(...)

Plot an EpivizChart within the environment

...

Arguments for epivizChart

register_shiny_handler(session)

Enable components to interact with Shiny session.

session

Shiny session object

remove_all_charts()

Remove all charts from environment

remove_chart(chart)

Remove chart from environment

render_component(shiny = FALSE)

Render to html

shiny

if rendering component in a shiny environment

set_charts(charts)

Set charts of environment


HCBravoLab/epivizrChart documentation built on Oct. 17, 2018, 2:28 a.m.