lkp_pyramid: Age Pyramid

In GuillaumeBiessy/Linkplots: LinkPact Styled Plots

Age Pyramid

Description

Age Pyramid

Usage

lkp_pyramid(
  df,
  x,
  y,
  f1,
  f2,
  fill,
  y_current,
  n_breaks_y = NULL,
  facet_type = "wrap",
  scales = "free_x",
  labeller = label_value,
  nrow = NULL,
  ncol = NULL,
  ...
)

Arguments

df	A data.frame containing the data to represent
x	The x axis variable for the histogram
y	Count Variable
f1	First optional variable for facet display
f2	Second optional variable for facet display
fill	A variable for which to show the breakdown in each histogram bar
y_current	Current year, required for secondary scale
n_breaks_y	Desired number of breaks for the y axis. Optional
facet_type	Should facet_wrap or facet_grid be used for facetting ?
scales	Should scales be fixed ("fixed", the default), free ("free"), or free in one dimension ("free_x", "free_y")?
labeller	A function that takes one data frame of labels and returns a list or data frame of character vectors. Each input column corresponds to one factor. Thus there will be more than one with vars(cyl, am). Each output column gets displayed as one separate line in the strip label. This function should inherit from the "labeller" S3 class for compatibility with labeller(). You can use different labeling functions for different kind of labels, for example use label_parsed() for formatting facet labels. label_value() is used by default, check it for more details and pointers to other options.
nrow, ncol	Number of rows and columns.
...	Additional parameters passed to the "ll_pyramid" function

Value

A ggplot object representing an age pyramid with one or several facets

GuillaumeBiessy/Linkplots documentation built on Sept. 11, 2023, 8:37 a.m.