card: ggforest – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

ggforest

Forest Plot of Hourly Odds

Description

Creates an OR plot for each hour of data given. Its a ggplot format so additional variables, like titles, can be added in.

Usage

ggforest(ot, time = "time", or = "OR", lower = "Lower", upper = "Upper")

Arguments

`ot`	Odd Ratio table with the following columns.
`time`	Name of time variable (or "grouping" variable)
`or`	Name of column containing odds ratio
`lower`	Name of column of lower boundary of 95 percent CI
`upper`	Name of column of upper boundary of 95 percent CI

Details

This function creates a forest plot using the OR developed by the card::circ_odds function in this package. By default, it takes the output, which is a tibble named "ot", and will generate a forest plot based on the grouping variable (default is time of day). Original data can be restricted or the hours can be reduced).

Value

A ggplot of forest plot that can be extended. Default theme is minimal and default color scheme is viridis.

Examples

# Data
data(twins)
ot <- circ_odds(twins, "hour", "sad_bin", "rDYX")

# Plot
library(ggplot2)
ggforest(ot) +
  labs(title = "Example") +
  scale_color_viridis_c(option = "A")

card

Cardiovascular and Autonomic Research Design

v0.1.0

MIT + file LICENSE

Authors

Anish S. Shah [aut, cre, cph] (<https://orcid.org/0000-0002-9729-1558>)

Initial release