getAgeGender {EpiReport} | R Documentation |
Get disease-specific age and gender bar graph
Description
Function returning the age and gender bar graph that will be included
in the epidemiological report at the bookmark location 'BARGPH_AGEGENDER'
of the template report.
The bar graph presents the distribution of cases at EU/EEA level using either:
AG-COUNT
: The number of cases by age and genderAG-RATE
: The rate per 100 000 cases by age and genderAG-PROP
: The proportion of cases by age and genderA-RATE
: The rate per 100 000 cases by age only
The choice of the type of bar graph is set in the report parameters table AERparams
.
(see ECDC reports
https://www.ecdc.europa.eu/en/all-topics-z/surveillance-and-disease-data/annual-epidemiological-reports-aers)
Usage
getAgeGender(
x = EpiReport::DENGUE2019,
disease = "DENGUE",
year = 2019,
reportParameters = EpiReport::AERparams,
geoCode = "EU_EEA31",
index = 1,
doc
)
Arguments
x |
dataframe, raw disease-specific dataset (see specification of the
dataset in the package vignette with |
disease |
character string, disease code (default |
year |
numeric, year to produce the graph for (default |
reportParameters |
dataframe, dataset including the required parameters
for the graph and report production (default |
geoCode |
character string, GeoCode to run the analysis on
(default |
index |
integer, figure number |
doc |
'Word' document (see |
Value
'Word' doc or a ggplot2 object
See Also
Global function for the full epidemilogical report: getAER
Required Packages: ggplot2
officer
Internal functions: plotBarGrouped
(use of plotAgeGender
discouraged)
plotBar
(use of plotAge
discouraged)
EcdcColors
Default datasets: AERparams
Examples
# --- Plot using the default dataset
getAgeGender()
# --- Plot using external dataset
# --- Please see examples in the vignette
browseVignettes(package = "EpiReport")