From 5c7eecfaada7df439098d083e197f79abae2559b Mon Sep 17 00:00:00 2001 From: Jennifer Thom Date: Tue, 9 Jan 2024 11:39:35 +0000 Subject: [PATCH] Update documentation --- R/calculate_stay.R | 5 +++-- man/calculate_stay.Rd | 1 - man/check_quarter_format.Rd | 37 ---------------------------------- man/compute_mid_year_age.Rd | 1 - man/convert_date_to_numeric.Rd | 1 - man/convert_numeric_to_date.Rd | 1 - man/end_fy.Rd | 1 - man/end_fy_quarter.Rd | 1 - man/end_next_fy_quarter.Rd | 1 - man/fy_interval.Rd | 1 - man/is_date_in_fyyear.Rd | 1 - man/last_date_month.Rd | 1 - man/midpoint_fy.Rd | 1 - man/next_fy.Rd | 1 - man/start_fy.Rd | 1 - man/start_fy_quarter.Rd | 1 - man/start_next_fy_quarter.Rd | 1 - 17 files changed, 3 insertions(+), 54 deletions(-) delete mode 100644 man/check_quarter_format.Rd diff --git a/R/calculate_stay.R b/R/calculate_stay.R index f4e8b56cb..ae80b33c1 100644 --- a/R/calculate_stay.R +++ b/R/calculate_stay.R @@ -36,9 +36,10 @@ calculate_stay <- function(year, start_date, end_date, sc_qtr = NULL) { # Check the quarters if (anyNA(sc_qtr)) { cli::cli_abort("Some of the submitted quarters are missing") - } else { - sc_qtr <- check_quarter_format(sc_qtr) } + # else { + # sc_qtr <- check_quarter_format(sc_qtr) + # } # Set Quarters qtr_end <- lubridate::add_with_rollback( diff --git a/man/calculate_stay.Rd b/man/calculate_stay.Rd index ff1653bfc..43b7bd166 100644 --- a/man/calculate_stay.Rd +++ b/man/calculate_stay.Rd @@ -31,7 +31,6 @@ If the \code{end_date} is missing then use the dummy discharge date. } \seealso{ Other date functions: -\code{\link{check_quarter_format}()}, \code{\link{compute_mid_year_age}()}, \code{\link{convert_date_to_numeric}()}, \code{\link{convert_numeric_to_date}()}, diff --git a/man/check_quarter_format.Rd b/man/check_quarter_format.Rd deleted file mode 100644 index a10c22404..000000000 --- a/man/check_quarter_format.Rd +++ /dev/null @@ -1,37 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/get_fy_quarter_dates.R -\name{check_quarter_format} -\alias{check_quarter_format} -\title{Check quarter format} -\usage{ -check_quarter_format(quarter) -} -\arguments{ -\item{quarter}{usually \code{period} from Social Care, or any character vector -in the form \code{YYYYQX} where \code{X} is the quarter number} -} -\value{ -\code{quarter} invisibly if no issues were found -} -\description{ -Check quarter format -} -\seealso{ -Other date functions: -\code{\link{calculate_stay}()}, -\code{\link{compute_mid_year_age}()}, -\code{\link{convert_date_to_numeric}()}, -\code{\link{convert_numeric_to_date}()}, -\code{\link{end_fy_quarter}()}, -\code{\link{end_fy}()}, -\code{\link{end_next_fy_quarter}()}, -\code{\link{fy_interval}()}, -\code{\link{is_date_in_fyyear}()}, -\code{\link{last_date_month}()}, -\code{\link{midpoint_fy}()}, -\code{\link{next_fy}()}, -\code{\link{start_fy_quarter}()}, -\code{\link{start_fy}()}, -\code{\link{start_next_fy_quarter}()} -} -\concept{date functions} diff --git a/man/compute_mid_year_age.Rd b/man/compute_mid_year_age.Rd index c27e32af5..142fa4aab 100644 --- a/man/compute_mid_year_age.Rd +++ b/man/compute_mid_year_age.Rd @@ -29,7 +29,6 @@ midpoint_fy Other date functions: \code{\link{calculate_stay}()}, -\code{\link{check_quarter_format}()}, \code{\link{convert_date_to_numeric}()}, \code{\link{convert_numeric_to_date}()}, \code{\link{end_fy_quarter}()}, diff --git a/man/convert_date_to_numeric.Rd b/man/convert_date_to_numeric.Rd index d0fa53e76..5511fec84 100644 --- a/man/convert_date_to_numeric.Rd +++ b/man/convert_date_to_numeric.Rd @@ -22,7 +22,6 @@ convert_date_to_numeric(as.Date("2021-03-31")) \seealso{ Other date functions: \code{\link{calculate_stay}()}, -\code{\link{check_quarter_format}()}, \code{\link{compute_mid_year_age}()}, \code{\link{convert_numeric_to_date}()}, \code{\link{end_fy_quarter}()}, diff --git a/man/convert_numeric_to_date.Rd b/man/convert_numeric_to_date.Rd index b501eb712..f786e0319 100644 --- a/man/convert_numeric_to_date.Rd +++ b/man/convert_numeric_to_date.Rd @@ -22,7 +22,6 @@ convert_numeric_to_date(c(20210101, 19993112)) \seealso{ Other date functions: \code{\link{calculate_stay}()}, -\code{\link{check_quarter_format}()}, \code{\link{compute_mid_year_age}()}, \code{\link{convert_date_to_numeric}()}, \code{\link{end_fy_quarter}()}, diff --git a/man/end_fy.Rd b/man/end_fy.Rd index 0e602a6f4..2925ffe60 100644 --- a/man/end_fy.Rd +++ b/man/end_fy.Rd @@ -24,7 +24,6 @@ end_fy("1718") \seealso{ Other date functions: \code{\link{calculate_stay}()}, -\code{\link{check_quarter_format}()}, \code{\link{compute_mid_year_age}()}, \code{\link{convert_date_to_numeric}()}, \code{\link{convert_numeric_to_date}()}, diff --git a/man/end_fy_quarter.Rd b/man/end_fy_quarter.Rd index 79d771f97..0efe9624a 100644 --- a/man/end_fy_quarter.Rd +++ b/man/end_fy_quarter.Rd @@ -23,7 +23,6 @@ end_fy_quarter("2019Q1") \seealso{ Other date functions: \code{\link{calculate_stay}()}, -\code{\link{check_quarter_format}()}, \code{\link{compute_mid_year_age}()}, \code{\link{convert_date_to_numeric}()}, \code{\link{convert_numeric_to_date}()}, diff --git a/man/end_next_fy_quarter.Rd b/man/end_next_fy_quarter.Rd index 3696eef7a..f9cc1720a 100644 --- a/man/end_next_fy_quarter.Rd +++ b/man/end_next_fy_quarter.Rd @@ -23,7 +23,6 @@ end_next_fy_quarter("2019Q1") \seealso{ Other date functions: \code{\link{calculate_stay}()}, -\code{\link{check_quarter_format}()}, \code{\link{compute_mid_year_age}()}, \code{\link{convert_date_to_numeric}()}, \code{\link{convert_numeric_to_date}()}, diff --git a/man/fy_interval.Rd b/man/fy_interval.Rd index 4eeaae1e3..12d1d36bb 100644 --- a/man/fy_interval.Rd +++ b/man/fy_interval.Rd @@ -23,7 +23,6 @@ fy_interval("1920") \seealso{ Other date functions: \code{\link{calculate_stay}()}, -\code{\link{check_quarter_format}()}, \code{\link{compute_mid_year_age}()}, \code{\link{convert_date_to_numeric}()}, \code{\link{convert_numeric_to_date}()}, diff --git a/man/is_date_in_fyyear.Rd b/man/is_date_in_fyyear.Rd index 8f12c4df1..97a0f3639 100644 --- a/man/is_date_in_fyyear.Rd +++ b/man/is_date_in_fyyear.Rd @@ -38,7 +38,6 @@ is_date_in_fyyear( \seealso{ Other date functions: \code{\link{calculate_stay}()}, -\code{\link{check_quarter_format}()}, \code{\link{compute_mid_year_age}()}, \code{\link{convert_date_to_numeric}()}, \code{\link{convert_numeric_to_date}()}, diff --git a/man/last_date_month.Rd b/man/last_date_month.Rd index 4d2078bcb..f52305356 100644 --- a/man/last_date_month.Rd +++ b/man/last_date_month.Rd @@ -22,7 +22,6 @@ last_date_month(Sys.Date()) \seealso{ Other date functions: \code{\link{calculate_stay}()}, -\code{\link{check_quarter_format}()}, \code{\link{compute_mid_year_age}()}, \code{\link{convert_date_to_numeric}()}, \code{\link{convert_numeric_to_date}()}, diff --git a/man/midpoint_fy.Rd b/man/midpoint_fy.Rd index 656e8c8ca..7bac9b6b3 100644 --- a/man/midpoint_fy.Rd +++ b/man/midpoint_fy.Rd @@ -24,7 +24,6 @@ midpoint_fy("1718") \seealso{ Other date functions: \code{\link{calculate_stay}()}, -\code{\link{check_quarter_format}()}, \code{\link{compute_mid_year_age}()}, \code{\link{convert_date_to_numeric}()}, \code{\link{convert_numeric_to_date}()}, diff --git a/man/next_fy.Rd b/man/next_fy.Rd index d23ae59da..19e1193f4 100644 --- a/man/next_fy.Rd +++ b/man/next_fy.Rd @@ -24,7 +24,6 @@ next_fy("1718") \seealso{ Other date functions: \code{\link{calculate_stay}()}, -\code{\link{check_quarter_format}()}, \code{\link{compute_mid_year_age}()}, \code{\link{convert_date_to_numeric}()}, \code{\link{convert_numeric_to_date}()}, diff --git a/man/start_fy.Rd b/man/start_fy.Rd index c8a2db5d2..4996bfb72 100644 --- a/man/start_fy.Rd +++ b/man/start_fy.Rd @@ -24,7 +24,6 @@ start_fy("1718") \seealso{ Other date functions: \code{\link{calculate_stay}()}, -\code{\link{check_quarter_format}()}, \code{\link{compute_mid_year_age}()}, \code{\link{convert_date_to_numeric}()}, \code{\link{convert_numeric_to_date}()}, diff --git a/man/start_fy_quarter.Rd b/man/start_fy_quarter.Rd index 0d97b5171..f5729dcb0 100644 --- a/man/start_fy_quarter.Rd +++ b/man/start_fy_quarter.Rd @@ -23,7 +23,6 @@ start_fy_quarter("2019Q1") \seealso{ Other date functions: \code{\link{calculate_stay}()}, -\code{\link{check_quarter_format}()}, \code{\link{compute_mid_year_age}()}, \code{\link{convert_date_to_numeric}()}, \code{\link{convert_numeric_to_date}()}, diff --git a/man/start_next_fy_quarter.Rd b/man/start_next_fy_quarter.Rd index 976a79d02..098f0bf73 100644 --- a/man/start_next_fy_quarter.Rd +++ b/man/start_next_fy_quarter.Rd @@ -23,7 +23,6 @@ start_next_fy_quarter("2019Q1") \seealso{ Other date functions: \code{\link{calculate_stay}()}, -\code{\link{check_quarter_format}()}, \code{\link{compute_mid_year_age}()}, \code{\link{convert_date_to_numeric}()}, \code{\link{convert_numeric_to_date}()},