inst/doc/display.R

In insight: Easy Access to Model Information for Various Model Objects

## ----include = FALSE----------------------------------------------------------
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)


pkgs <- c("datawizard", "gt", "tinytable")
if (!all(insight::check_if_installed(pkgs, quietly = TRUE))) {
  knitr::opts_chunk$set(eval = FALSE)
}
if (getRversion() < "4.1.0") {
  knitr::opts_chunk$set(eval = FALSE)
}

## ----warning=FALSE, message=FALSE---------------------------------------------
library(insight)

df <- data.frame(
  Variable = c(1, 3, 5, 3, 1),
  Group = c("A", "A", "A", "B", "B"),
  CI = c(0.95, 0.95, 0.95, 0.95, 0.95),
  CI_low = c(3.35, 2.425, 6.213, 12.1, 1.23),
  CI_high = c(4.23, 5.31, 7.123, 13.5, 3.61),
  p = c(0.001, 0.0456, 0.45, 0.0042, 0.34)
)

df

## ----eval=FALSE---------------------------------------------------------------
# knitr::kable(df, format = "markdown")

## ----results='asis'-----------------------------------------------------------
knitr::kable(df, format = "html")

## -----------------------------------------------------------------------------
format_table(df)

## -----------------------------------------------------------------------------
library(datawizard) # for data_modify()
df |>
  data_modify(p = format_p(p, stars = TRUE)) |>
  format_table()

## ----eval=.Platform$OS.type == "windows"--------------------------------------
x <- data.frame(
  phi_adjusted = 0.3,
  Glass_delta = 0.4,
  Epsilon2 = 0.7,
  R2 = 0.4
)

# standard output
format_table(x)

# column names of effect sizes as symbols
format_table(x, use_symbols = TRUE)

## ----eval=.Platform$OS.type == "windows"--------------------------------------
export_table(format_table(x, use_symbols = TRUE))

## -----------------------------------------------------------------------------
export_table(df)

## -----------------------------------------------------------------------------
export_table(df, format = "md")

## -----------------------------------------------------------------------------
export_table(df, format = "html")

## -----------------------------------------------------------------------------
df |>
  format_table(ci_brackets = c("(", ")")) |>
  export_table(format = "html")

## -----------------------------------------------------------------------------
# By default, display() creates a markdown table
display(df)

## ----results='asis'-----------------------------------------------------------
display(df, format = "html")

## -----------------------------------------------------------------------------
display(df, format = "tt")