stayed_between: stayed_between

In COHHIO/HMIS: Filters HMIS Data by Meaningful Date Ranges

stayed_between

Description

Much like served_between(), but for Rapid Rehousing and Permanent Supportive Housing projects, it measures from Move In Date to Exit Date instead of Entry Date to Exit Date. Useful for when you want to only count households who moved into housing or measure the time that household occupied bed inventory.

Usage

stayed_between(., start = NULL, end = NULL, lgl = FALSE)

Arguments

start	Default = ReportStart, character/date of the start of the date range. Characters in format mdY, Ymd, dmY acceptable. Will be automatically retrieved from parent environments if not specified. If start is named other than ReportStart, it must be specified.
end	Default = ReportEnd, character/date of the end of the date range. Characters in format mdY, Ymd, dmY acceptable. Will be automatically retrieved from parent environments if not specified. If end is named other than ReportEnd, it must be specified.
lgl	Default = FALSE, logical, flag to force logical vector output.

Details

Context-sensitive: Automatically detects if nested inside of filter call, if so returns logical instead of data.frame. Enrollment-related functions require Enrollment data elements such as Entry Date, Exit Date, Move In Date, and Project Type (of the Enrollment's Project). Project Descriptor-related functions require Project data elements such as Operating Start/End dates and Bed Inventory Start/End dates.

Value

data.frame/logical after filtering/applying conditional to the appropriate columns

See Also

Other _between: beds_available_between(), between_df(), entered_between(), exited_between(), operating_between(), served_between()

Examples

## Not run: 
library(dplyr)
ReportStart <- Sys.Date() - lubridate::weeks(4)
ReportEnd <- Sys.Date()
identical(
served_between(qpr_leavers),
qpr_leavers %>% filter(served_between(., lgl = TRUE))
)

## End(Not run)

COHHIO/HMIS documentation built on Sept. 8, 2024, 7:47 a.m.