AMR/man/age_groups.Rd

85 lines
3.5 KiB
Plaintext
Raw Normal View History

2018-12-15 22:40:07 +01:00
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/age.R
\name{age_groups}
\alias{age_groups}
\title{Split Ages into Age Groups}
2018-12-15 22:40:07 +01:00
\usage{
age_groups(x, split_at = c(12, 25, 55, 75), na.rm = FALSE)
2018-12-15 22:40:07 +01:00
}
\arguments{
\item{x}{age, e.g. calculated with \code{\link[=age]{age()}}}
2018-12-15 22:40:07 +01:00
\item{split_at}{values to split \code{x} at, defaults to age groups 0-11, 12-24, 25-54, 55-74 and 75+. See \emph{Details}.}
2020-03-07 21:48:21 +01:00
\item{na.rm}{a \link{logical} to indicate whether missing values should be removed}
2018-12-15 22:40:07 +01:00
}
\value{
2020-03-07 21:48:21 +01:00
Ordered \link{factor}
2018-12-15 22:40:07 +01:00
}
\description{
2020-12-22 00:51:17 +01:00
Split ages into age groups defined by the \code{split} argument. This allows for easier demographic (antimicrobial resistance) analysis.
2018-12-15 22:40:07 +01:00
}
\details{
2020-12-22 00:51:17 +01:00
To split ages, the input for the \code{split_at} argument can be:
2018-12-15 22:40:07 +01:00
\itemize{
2021-05-12 18:15:03 +02:00
\item A \link{numeric} vector. A value of e.g. \code{c(10, 20)} will split \code{x} on 0-9, 10-19 and 20+. A value of only \code{50} will split \code{x} on 0-49 and 50+.
The default is to split on young children (0-11), youth (12-24), young adults (25-54), middle-aged adults (55-74) and elderly (75+).
\item A character:
\itemize{
\item \code{"children"} or \code{"kids"}, equivalent of: \code{c(0, 1, 2, 4, 6, 13, 18)}. This will split on 0, 1, 2-3, 4-5, 6-12, 13-17 and 18+.
\item \code{"elderly"} or \code{"seniors"}, equivalent of: \code{c(65, 75, 85)}. This will split on 0-64, 65-74, 75-84, 85+.
\item \code{"fives"}, equivalent of: \code{1:20 * 5}. This will split on 0-4, 5-9, ..., 95-99, 100+.
\item \code{"tens"}, equivalent of: \code{1:10 * 10}. This will split on 0-9, 10-19, ..., 90-99, 100+.
}
2018-12-15 22:40:07 +01:00
}
}
\section{Stable Lifecycle}{
\if{html}{\figure{lifecycle_stable.svg}{options: style=margin-bottom:"5"} \cr}
2020-07-08 14:48:06 +02:00
The \link[=lifecycle]{lifecycle} of this function is \strong{stable}. In a stable function, major changes are unlikely. This means that the unlying code will generally evolve by adding new arguments; removing arguments or changing the meaning of existing arguments will be avoided.
2022-03-10 19:33:25 +01:00
If the unlying code needs breaking changes, they will occur gradually. For example, an argument will be deprecated and first continue to work, but will emit a message informing you of the change. Next, typically after at least one newly released version on CRAN, the message will be transformed to an error.
}
\section{Read more on Our Website!}{
2019-01-02 23:24:07 +01:00
2021-06-01 15:33:06 +02:00
On our website \url{https://msberends.github.io/AMR/} you can find \href{https://msberends.github.io/AMR/articles/AMR.html}{a comprehensive tutorial} about how to conduct AMR data analysis, the \href{https://msberends.github.io/AMR/reference/}{complete documentation of all functions} and \href{https://msberends.github.io/AMR/articles/WHONET.html}{an example analysis using WHONET data}.
2019-01-02 23:24:07 +01:00
}
2018-12-15 22:40:07 +01:00
\examples{
ages <- c(3, 8, 16, 54, 31, 76, 101, 43, 21)
# split into 0-49 and 50+
2018-12-15 22:40:07 +01:00
age_groups(ages, 50)
# split into 0-19, 20-49 and 50+
age_groups(ages, c(20, 50))
2018-12-15 22:40:07 +01:00
# split into groups of ten years
2019-04-09 10:34:40 +02:00
age_groups(ages, 1:10 * 10)
age_groups(ages, split_at = "tens")
2018-12-15 22:40:07 +01:00
# split into groups of five years
2019-04-09 10:34:40 +02:00
age_groups(ages, 1:20 * 5)
age_groups(ages, split_at = "fives")
2018-12-15 22:40:07 +01:00
# split specifically for children
age_groups(ages, c(1, 2, 4, 6, 13, 17))
age_groups(ages, "children")
2018-12-15 22:40:07 +01:00
\donttest{
# resistance of ciprofloxacin per age group
if (require("dplyr")) {
example_isolates \%>\%
filter_first_isolate() \%>\%
filter(mo == as.mo("E. coli")) \%>\%
group_by(age_group = age_groups(age)) \%>\%
select(age_group, CIP) \%>\%
ggplot_rsi(x = "age_group", minimum = 0)
}
2018-12-15 22:40:07 +01:00
}
2019-11-03 22:41:29 +01:00
}
2018-12-15 22:40:07 +01:00
\seealso{
To determine ages, based on one or more reference dates, use the \code{\link[=age]{age()}} function.
2018-12-15 22:40:07 +01:00
}