Skip to content

Commit 46b5271

Browse files
committed
update comment prefix
1 parent 7be562c commit 46b5271

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

R/update_hub_target_data.R

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,22 @@ nssp_col_names <- list(
77
rsv = "percent_visits_rsv"
88
)
99

10-
##' Get and process target data for the hub
11-
##'
12-
##' This function pulls, formats and save NHSN and NSSP data for use in the hub.
13-
##'
14-
##' @param base_hub_path Path to the base hub directory.
15-
##' @param disease Disease name ("covid" or "rsv").
16-
##' @param excluded_locations Vector of location codes to exclude from the output.
17-
##' Default value is c("78", "69", "66", "60"), corresponding to "US Virgin Islands",
18-
##' "Guam", "American Samoa", and "Northern Mariana Islands".
19-
##' @param nhsn_first_weekending_date First week-ending date to include for
20-
##' the NHSN dataset. Default value is "2024-11-09".
21-
##' @param legacy_file Logical. Whether to write legacy CSV output (default: FALSE).
22-
##'
23-
##' @return Writes `time-series.parquet` and optionally legacy csv target data files
24-
##' to the target-data directory in the hub.
25-
##' @export
10+
#' Get and process target data for the hub
11+
#'
12+
#' This function pulls, formats and save NHSN and NSSP data for use in the hub.
13+
#'
14+
#' @param base_hub_path Path to the base hub directory.
15+
#' @param disease Disease name ("covid" or "rsv").
16+
#' @param excluded_locations Vector of location codes to exclude from the output.
17+
#' Default value is c("78", "69", "66", "60"), corresponding to "US Virgin Islands",
18+
#' "Guam", "American Samoa", and "Northern Mariana Islands".
19+
#' @param nhsn_first_weekending_date First week-ending date to include for
20+
#' the NHSN dataset. Default value is "2024-11-09".
21+
#' @param legacy_file Logical. Whether to write legacy CSV output (default: FALSE).
22+
#'
23+
#' @return Writes `time-series.parquet` and optionally legacy csv target data files
24+
#' to the target-data directory in the hub.
25+
#' @export
2626
update_hub_target_data <- function(
2727
base_hub_path,
2828
disease,

0 commit comments

Comments
 (0)