Skip to contents

# Implemented functions

Source: `R/data_plots.R`
`supported_plots.Rd`

Library of supported functions. The list name and "descr" element should be unique for each element on list.

- descr: Plot description

- primary.type: Primary variable data type (continuous, dichotomous or ordinal)

- secondary.type: Secondary variable data type (continuous, dichotomous or ordinal)

- secondary.extra: "none" or NULL to have option to choose none.

- tertiary.type: Tertiary variable data type (continuous, dichotomous or ordinal)

## Usage

    supported_plots()

## Value

list

## Examples

    supported_plots() |> str()
    #> List of 6
    #>  $ plot_hbars  :List of 8
    #>   ..$ fun            : chr "plot_hbars"
    #>   ..$ descr          : chr "Stacked horizontal bars"
    #>   ..$ note           : chr "A classical way of visualising the distribution of an ordinal scale like the modified Ranking Scale and known as Grotta bars"
    #>   ..$ primary.type   : chr [1:2] "dichotomous" "categorical"
    #>   ..$ secondary.type : chr [1:2] "dichotomous" "categorical"
    #>   ..$ secondary.multi: logi FALSE
    #>   ..$ tertiary.type  : chr [1:2] "dichotomous" "categorical"
    #>   ..$ secondary.extra: chr "none"
    #>  $ plot_violin :List of 8
    #>   ..$ fun            : chr "plot_violin"
    #>   ..$ descr          : chr "Violin plot"
    #>   ..$ note           : chr "A modern alternative to the classic boxplot to visualise data distribution"
    #>   ..$ primary.type   : chr [1:4] "datatime" "continuous" "dichotomous" "categorical"
    #>   ..$ secondary.type : chr [1:2] "dichotomous" "categorical"
    #>   ..$ secondary.multi: logi FALSE
    #>   ..$ secondary.extra: chr "none"
    #>   ..$ tertiary.type  : chr [1:2] "dichotomous" "categorical"
    #>  $ plot_sankey :List of 8
    #>   ..$ fun            : chr "plot_sankey"
    #>   ..$ descr          : chr "Sankey plot"
    #>   ..$ note           : chr "A way of visualising change between groups"
    #>   ..$ primary.type   : chr [1:2] "dichotomous" "categorical"
    #>   ..$ secondary.type : chr [1:2] "dichotomous" "categorical"
    #>   ..$ secondary.multi: logi FALSE
    #>   ..$ secondary.extra: NULL
    #>   ..$ tertiary.type  : chr [1:2] "dichotomous" "categorical"
    #>  $ plot_scatter:List of 8
    #>   ..$ fun            : chr "plot_scatter"
    #>   ..$ descr          : chr "Scatter plot"
    #>   ..$ note           : chr "A classic way of showing the association between to variables"
    #>   ..$ primary.type   : chr [1:2] "datatime" "continuous"
    #>   ..$ secondary.type : chr [1:3] "datatime" "continuous" "categorical"
    #>   ..$ secondary.multi: logi FALSE
    #>   ..$ tertiary.type  : chr [1:2] "dichotomous" "categorical"
    #>   ..$ secondary.extra: NULL
    #>  $ plot_box    :List of 8
    #>   ..$ fun            : chr "plot_box"
    #>   ..$ descr          : chr "Box plot"
    #>   ..$ note           : chr "A classic way to plot data distribution by groups"
    #>   ..$ primary.type   : chr [1:4] "datatime" "continuous" "dichotomous" "categorical"
    #>   ..$ secondary.type : chr [1:2] "dichotomous" "categorical"
    #>   ..$ secondary.multi: logi FALSE
    #>   ..$ tertiary.type  : chr [1:2] "dichotomous" "categorical"
    #>   ..$ secondary.extra: chr "none"
    #>  $ plot_euler  :List of 9
    #>   ..$ fun            : chr "plot_euler"
    #>   ..$ descr          : chr "Euler diagram"
    #>   ..$ note           : chr "Generate area-proportional Euler diagrams to display set relationships"
    #>   ..$ primary.type   : chr [1:2] "dichotomous" "categorical"
    #>   ..$ secondary.type : chr [1:2] "dichotomous" "categorical"
    #>   ..$ secondary.multi: logi TRUE
    #>   ..$ secondary.max  : num 4
    #>   ..$ tertiary.type  : chr [1:2] "dichotomous" "categorical"
    #>   ..$ secondary.extra: NULL