From 537df5133bf135dbdef9cc5cf14c1f539279d16e Mon Sep 17 00:00:00 2001 From: Rafa Lopes Date: Thu, 1 Sep 2022 15:09:53 -0300 Subject: [PATCH] typos and better description to age_col --- R/nowcasting_inla.R | 6 +++--- man/nowcasting_inla.Rd | 6 +++--- vignettes/nowcaster.Rmd | 3 ++- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/R/nowcasting_inla.R b/R/nowcasting_inla.R index 099e617..475adaa 100644 --- a/R/nowcasting_inla.R +++ b/R/nowcasting_inla.R @@ -15,16 +15,16 @@ #' [Default] 30 weeks. #' @param data.by.week If it has to be returned the whole time-series data. #' [Default] FALSE. -#' @param return.age [Depracted] If the estimate by Age should be returned. +#' @param return.age [Deprecated] If the estimate by Age should be returned. #' [Default] TRUE. #' @param bins_age Age bins to do the nowcasting, it receive a vector of age bins, #' or options between, "SI-PNI", "10 years", "5 years". #' [Default] "SI-PNI". -#' @param silent [Depracted] Should be the warnings turned off? +#' @param silent Should be the warnings turned off? #' [Default] is TRUE. #' @param K (in weeks) How much weeks to forecast ahead? #' [Default] K is 0, no forecasting ahead -#' @param age_col Column for ages +#' @param age_col Column for ages on individual level data, in numeric values #' @param date_onset Column of dates of onset of the events, normally date of onset of first symptoms of cases #' @param date_report Column of dates of report of the event, normally date of digitation of the notification of cases #' @param trajectories Returns the trajectories estimated on the inner 'INLA' model diff --git a/man/nowcasting_inla.Rd b/man/nowcasting_inla.Rd index 3a89c32..96abd61 100644 --- a/man/nowcasting_inla.Rd +++ b/man/nowcasting_inla.Rd @@ -36,7 +36,7 @@ or options between, "SI-PNI", "10 years", "5 years". \item{wdw}{(in weeks) Window of dates the estimation will act, i.e., how many past weeks the nowcasting will estimates. \link{Default} 30 weeks.} -\item{age_col}{Column for ages} +\item{age_col}{Column for ages on individual level data, in numeric values} \item{date_onset}{Column of dates of onset of the events, normally date of onset of first symptoms of cases} @@ -45,7 +45,7 @@ or options between, "SI-PNI", "10 years", "5 years". \item{data.by.week}{If it has to be returned the whole time-series data. \link{Default} FALSE.} -\item{silent}{\link{Depracted} Should be the warnings turned off? +\item{silent}{Should be the warnings turned off? \link{Default} is TRUE.} \item{K}{(in weeks) How much weeks to forecast ahead? @@ -55,7 +55,7 @@ or options between, "SI-PNI", "10 years", "5 years". \item{...}{} -\item{return.age}{\link{Depracted} If the estimate by Age should be returned. +\item{return.age}{\link{Deprecated} If the estimate by Age should be returned. \link{Default} TRUE.} } \value{ diff --git a/vignettes/nowcaster.Rmd b/vignettes/nowcaster.Rmd index 196e81f..0274c2d 100644 --- a/vignettes/nowcaster.Rmd +++ b/vignettes/nowcaster.Rmd @@ -42,7 +42,8 @@ The call of the function is straightforward, it simply needs a dataset as input, nowcasting_bh_no_age <- nowcasting_inla(dataset = sragBH, date_onset = DT_SIN_PRI, date_report = DT_DIGITA, - data.by.week = T) + data.by.week = T, + silent = T) head(nowcasting_bh_no_age$total) ```