get_sunburst: Generate a sunburst plot using a forward warped dataset.

Description Usage Arguments Value

View source: R/get_sunburst.R

Description

Generate a sunburst plot using a forward warped dataset.

Usage

1
get_sunburst(dataset, rois = c("CH", "BS"), parent = TRUE)

Arguments

dataset

(required) Whole brain dataset returned as an output of the forward_warp() function.

rois

(optional, default = c("CH", "BS")) The acronyms of the regions of interest. Acronyms must follow Allen Brain Atlas abbreviation standards.

parent

(optional, default = TRUE) TRUE allows multiple rois to be plotted on the same sunburst, with the base parent layer set to 'grey'. If FALSE, the base will be set to the first ROI. Other ROIs will be ignored because the sunburst cannot accomodate more than one base layer.

Value

Returns an object of class sunburst.


mjin1812/SMART documentation built on Aug. 8, 2019, 12:31 p.m.