ssm_table: Create HTML table from SSM results or contrasts

View source: R/ssm_visualization.R

ssm_tableR Documentation

Create HTML table from SSM results or contrasts

Description

Take in the results of an SSM analysis and return an HTML table with the desired formatting.

Usage

ssm_table(.ssm_object, caption = NULL, xy = TRUE, render = TRUE)

Arguments

.ssm_object

The output of ssm_profiles() or ssm_measures()

caption

A string to be displayed above the table (default = NULL).

xy

A logical indicating whether the x-value and y-value parameters should be included in the table as columns (default = TRUE).

render

A logical indicating whether the table should be displayed in the RStudio viewer or web browser (default = TRUE).

Value

A tibble containing the information for the HTML table. As a side-effect, may also output the HTML table to the web viewer.

See Also

Other ssm functions: ssm_analyze(), ssm_append(), ssm_parameters(), ssm_plot(), ssm_score()

Other table functions: html_render(), ssm_append()

Examples


# Load example data
data("jz2017")

# Create table of profile results
res <- ssm_analyze(jz2017,
  scales = PA:NO, angles = octants(),
  measures = c(NARPD, ASPD)
)
ssm_table(res)

# Create table of contrast results
res <- ssm_analyze(jz2017,
  scales = PA:NO, angles = octants(),
  measures = c(NARPD, ASPD), contrast = "test"
)
ssm_table(res)



jmgirard/circumplex documentation built on Aug. 31, 2023, 8:03 a.m.