From 6195c78766d4567dff08dbac3704a291ac1878b0 Mon Sep 17 00:00:00 2001 From: Jennifer Thom Date: Tue, 26 Sep 2023 12:20:22 +0100 Subject: [PATCH] Update documentation --- NAMESPACE | 2 +- man/add_homelessness_date_flags.Rd | 2 -- man/add_homelessness_flag.Rd | 2 -- man/create_episode_file.Rd | 1 + man/create_homelessness_lookup.Rd | 2 -- man/create_individual_file.Rd | 2 -- 6 files changed, 2 insertions(+), 9 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index d7b5c1c3a..81a9d612e 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -16,8 +16,8 @@ export(convert_hscp_to_hscpnames) export(convert_numeric_to_date) export(convert_sending_location_to_lca) export(convert_year_to_fyyear) -export(create_homelessness_lookup) export(create_episode_file) +export(create_homelessness_lookup) export(create_individual_file) export(create_service_use_cohorts) export(end_fy) diff --git a/man/add_homelessness_date_flags.Rd b/man/add_homelessness_date_flags.Rd index 7b386a185..9d15d1ceb 100644 --- a/man/add_homelessness_date_flags.Rd +++ b/man/add_homelessness_date_flags.Rd @@ -14,8 +14,6 @@ add_homelessness_date_flags( \item{data}{The data to add the flag to - the episode or individual file.} -\item{year}{The year to process, in FY format.} - \item{lookup}{The homelessness lookup created by \code{\link[=create_homelessness_lookup]{create_homelessness_lookup()}}} } \value{ diff --git a/man/add_homelessness_flag.Rd b/man/add_homelessness_flag.Rd index 1ab409020..2dfc87678 100644 --- a/man/add_homelessness_flag.Rd +++ b/man/add_homelessness_flag.Rd @@ -10,8 +10,6 @@ add_homelessness_flag(data, year, lookup = create_homelessness_lookup(year)) \item{data}{The data to add the flag to - the episode or individual file.} -\item{year}{The year to process, in FY format.} - \item{lookup}{The homelessness lookup created by \code{\link[=create_homelessness_lookup]{create_homelessness_lookup()}}} } \value{ diff --git a/man/create_episode_file.Rd b/man/create_episode_file.Rd index c1ce0e063..5d85744e2 100644 --- a/man/create_episode_file.Rd +++ b/man/create_episode_file.Rd @@ -8,6 +8,7 @@ create_episode_file( processed_data_list, year, dd_data = read_file(get_source_extract_path(year, "DD")), + homelessness_lookup = create_homelessness_lookup(year), nsu_cohort = read_file(get_nsu_path(year)), ltc_data = read_file(get_ltcs_path(year)), slf_pc_lookup = read_file(get_slf_postcode_path()), diff --git a/man/create_homelessness_lookup.Rd b/man/create_homelessness_lookup.Rd index 4a0be24f9..a857d52d6 100644 --- a/man/create_homelessness_lookup.Rd +++ b/man/create_homelessness_lookup.Rd @@ -10,8 +10,6 @@ create_homelessness_lookup( ) } \arguments{ -\item{year}{The year to process, in FY format.} - \item{homelessness_data}{the processed homelessness data for the financial year (created with \code{\link[=process_extract_homelessness]{process_extract_homelessness()}}).} } diff --git a/man/create_individual_file.Rd b/man/create_individual_file.Rd index ffe7035d0..4c87b0731 100644 --- a/man/create_individual_file.Rd +++ b/man/create_individual_file.Rd @@ -18,8 +18,6 @@ create_individual_file( \item{year}{The year to process, in FY format.} -\item{homelessness_lookup}{dataframe with CHI, start date, end date. Creates hl1_in_fy flag.} - \item{write_to_disk}{(optional) Should the data be written to disk default is \code{TRUE} i.e. write the data to disk.}