bp_chart.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/bp_charts.R
\name{bp_chart}
\alias{bp_chart}
\title{Blood Pressure Charts}
\usage{
bp_chart(
  bp = c("sbp", "dbp"),
  male = 0:1,
  height = NA,
  height_percentile = NA,
  default_height_percentile = 0.5,
  p = c(0.01, 0.05, 0.1, 0.25, 0.5, 0.75, 0.9, 0.95, 0.99),
  source = getOption("pedbp_bp_source", "martin2022")
)
}
\arguments{
\item{bp}{character vector controlling if the systolic and/or the diastolic
pressures are plotted}

\item{male}{integer value, 1 = male, 0 = female}

\item{height}{numeric, in centimeters, can be missing. See Details.}

\item{height_percentile}{height percentile to use; range from [0, 100]. See Details.}

\item{default_height_percentile}{default height percentile to use if \code{height} is
missing; range (0, 100).}

\item{p}{a numeric vector of the percentiles, provided in values between 0
and 1, to plot}

\item{source}{the method, or data set, to use as the reference.  See Details.}
}
\description{
Build blood pressure charts showing select percentile curves over age by sex,
height, and source.
}
\examples{

bp_chart(male = 0:1)
bp_chart(male = 1)
bp_chart(male = 0)
bp_chart(male = 0, source = "gemelli1990")
bp_chart("sbp", male = 0, source = "gemelli1990")
bp_chart("dbp", male = 1, source = "gemelli1990")

bp_chart("sbp", male = 1, source = "nhlbi")
bp_chart("sbp", male = 1, source = "flynn2017")

# if you want to modify the plot, it might be helpful to see the data it is
# based on
g <- bp_chart(male = 1)
head(g$data)

# here we color the background to show the source reference values
bkgrnd <- aggregate(x = age ~ male + bp + source, data = g$data, FUN = range)

g +
  ggplot2::theme_bw() +
  ggplot2::geom_rect(
    data = bkgrnd,
    mapping = ggplot2::aes(xmin = age[, 1],
                           xmax = age[, 2] + 1,
                           ymin = -Inf,
                           ymax = Inf,
                           fill = source)
  ) +
  ggplot2::scale_fill_manual(
    name = "Data\nSource",
    values = c("gemelli1990" = ggplot2::alpha("#236192", 0.5)
               , "nhlbi"  = ggplot2::alpha("#6F263D", 0.5)
               , "lo2013"     = ggplot2::alpha("#A2AAAD", 0.5)
               ))

}