PropModality.Doughnut {MARVEL}

Overall modality proportion

Description

Tabulates and plots the proportion of each modality without breaking down by splicing event type.

Usage

PropModality.Doughnut(MarvelObject, modality.column, modality.type, event.type)

Arguments

MarvelObject

Marvel object. S3 object generated from AssignModality function.

modality.column

Character string. Can take the value "modality", "modality.var" or "modality.bimodal.adj". Please refer to AssignModality function help page for more details.

modality.type

Character string. basic indicates that only the main modalities (included, excluded, bimodal, middle, multimodal) are analysed. Sub-modalities (primary and dispersed) will be merged. complete indicates that both main and sub-modalities are analysed. Sub-modalities will not be merged.

event.type

Character string. To indicate which event type to analyse. Can take the value "SE", "MXE", "RI", "A5SS" or "A3SS". Specify "all" to include all event types.

Value

An object of class S3 with new slots MarvelObject$Modality$Prop$DoughnutChart$Table and MarvelObject$Modality$Prop$DoughnutChart$Plot.

Examples

marvel.demo <- readRDS(system.file("extdata/data", "marvel.demo.rds", package="MARVEL"))

marvel.demo <- PropModality.Doughnut(MarvelObject=marvel.demo,
                                     modality.column="modality.bimodal.adj",
                                     modality.type="extended",
                                     event.type=c("SE", "MXE", "RI", "A5SS", "A3SS", "AFE", "ALE")
                                     )

# Check outputs
marvel.demo$Modality$Prop$DoughnutChart$Table
marvel.demo$Modality$Prop$DoughnutChart$Plot