Age Pyramid

Age Pyramid

Usage

agepyramid(
  data,
  age = NULL,
  gender = NULL,
  female,
  male,
  age_groups = "custom",
  age_interval = "left",
  bin_width = 5,
  custom_breaks = "",
  plot_title = "Age Pyramid",
  color_palette = "standard",
  female_color = "#E91E63",
  male_color = "#2196F3",
  originaltheme = FALSE,
  enableGGCharts = FALSE,
  ggcharts_sort = "no",
  ggcharts_colors = "default",
  ggcharts_color1 = "#1F77B4",
  ggcharts_color2 = "#FF7F0E",
  ggcharts_title = "Age Pyramid (ggcharts)",
  ggcharts_xlab = "Population"
)

Arguments

data

The data as a data frame.

age

a string naming the variable from data that contains the continuous values used for the report

gender

a string naming the variable from data that contains the categorical values used for the report

female

a string naming the level from gender that contains the level female

male

a string naming the level from gender that contains the level male

age_groups

Predefined age group categories. Choose 'custom' to use bin_width, or select a preset. 'who' gives the WHO/UN standard five-year groups (0-4, 5-9, ... 85+) used by the WHO World Standard Population and UN population pyramids; 'who_infant' is the WHO abridged life-table grouping, which reports infants (<1) separately from children aged 1-4. All bands are left-closed, so an age on a boundary starts the band named for it.

age_interval

Which end of an age band is closed. 'left' gives [lower, upper) bands, the WHO/UN and demographic convention: a person aged exactly 65 starts the 65-69 band, and equal-width bands hold equal numbers of single years. 'right' gives (lower, upper] bands, where age 65 closes the band below it; this reproduces the behaviour of releases before 1.0.52 and makes the lowest band one year wider than the others, which inflates the youngest bar of the pyramid.

[lower, upper) bands, the WHO/UN and demographic convention: a person aged exactly 65 starts the 65-69 band, and equal-width bands hold equal numbers of single years. 'right' gives (lower, upper]: R:lower,%20upper)%20bands,%20the%20WHO/UN%20and%20demographic%20convention:%20a%20person%20aged%0Aexactly%2065%20starts%20the%2065-69%20band,%20and%20equal-width%20bands%20hold%20equal%20numbers%0Aof%20single%20years.%20'right'%20gives%20(lower,%20upper

bin_width

The width of the age bins in years. Adjust this to change the granularity of the age groups.

custom_breaks

Comma-separated age break points (e.g., "0,18,25,50,65,100"). Only used when age_groups is set to 'custom'. Leave empty to use bin_width.

plot_title

The title displayed on the age pyramid plot.

color_palette

Color palette for gender visualization. Choose 'custom' to specify your own colors.

female_color

Custom color for female bars (hex code). Only used when color_palette is 'custom'.

male_color

Custom color for male bars (hex code). Only used when color_palette is 'custom'.

originaltheme

Whether to apply the original custom theme (theme_minimal with custom tweaks) instead of jamovi's default theme.

enableGGCharts

Enable the ggcharts pyramid_chart() visualization as a second plot. This provides an alternative visualization style using the ggcharts package.

ggcharts_sort

Sort bars by population count. Options: 'no' (default order), 'ascending' (smallest to largest), 'descending' (largest to smallest).

ggcharts_colors

Color scheme for ggcharts pyramid. 'default' uses ggcharts defaults, or select from preset palettes or custom colors.

ggcharts_color1

Custom color for first group (hex code). Used when ggcharts_colors is 'custom'.

ggcharts_color2

Custom color for second group (hex code). Used when ggcharts_colors is 'custom'.

ggcharts_title

Title for the ggcharts pyramid plot.

ggcharts_xlab

X-axis label for ggcharts pyramid.

Value

A results object containing:

results$welcome					a html
results$dataInfo					a html
results$pyramidTable					a table
results$plot					an image
results$plotGGCharts					an image

Tables can be converted to data frames with asDF or as.data.frame. For example:

results$pyramidTable$asDF

as.data.frame(results$pyramidTable)