summarise_recency: Count the Number of Recency Outcomes Based on a Specified...

View source: R/summarise_recency.R

summarise_recencyR Documentation

Count the Number of Recency Outcomes Based on a Specified Level

Description

The summarise_recency() function counts the number of occurrence of specified level for each of the supplied dataframe. It then combines the given dataframes into a single table. It also adds a "Total" roll that adds all the rows for each of the numeric columns.

Usage

summarise_recency(..., level = "facility_state", names = NULL)

Arguments

...

Data frames to be summarised.

level

The level at which the summary should be performed. The options are "ip" (or "country"), "facility_state", "facility_lga", "facility", "client_state", or "client_lga".

names

The names to be passed to the summary columns created in the output

Value

summary dataframe of recency indicators

Examples

hts_pos <- hts_tst_pos(recency_example, from = "2021-01-01") # positive clients from January 2021
hts_recent <- hts_recent(hts_pos) # positive clients from above who had recency testing done
rtri_recent <- rtri_recent(hts_recent) # hts_recent clients who were presumed recent from RTRI

summarise_recency(
  hts_pos,
  hts_recent,
  rtri_recent,
  level = "facility_state",
  names = c("positives", "recency_testing", "rtri_recent")
)

### If the `names` argument is not supplied, the names of the supplied data will be used instead
summarise_recency(
  hts_pos,
  hts_recent
)


tidyndr documentation built on April 8, 2022, 9:06 a.m.