refactor(importfrom): switch package-level documentation (#23)

Author: amyheather

R/add_patient_generator.R

@@ -17,8 +17,6 @@
 #' structure \code{param$<unit>_arrivals$<patient_type>} containing numeric
 #' arrival intervals (e.g., \code{param$asu_arrivals$stroke = 10}).
 #'
-#' @importFrom simmer add_generator
-#'
 #' @return The modified Simmer environment with the new patient generator added.
 #' @export
 

R/create_asu_trajectory.R

@@ -13,9 +13,6 @@
 #' of routing to each destination (e.g.
 #' \code{param$asu_routing$stroke$rehab = 0.24}).
 #'
-#' @importFrom simmer branch get_attribute log_ release seize set_attribute
-#' @importFrom simmer timeout trajectory
-#'
 #' @return Simmer trajectory object. Defines patient journey logic through the
 #' healthcare system.
 #' @export

R/create_rehab_trajectory.R

@@ -13,9 +13,6 @@
 #' probability of routing to each destination (e.g.
 #' \code{param$rehab_routing$stroke$esd = 0.40}).
 #'
-#' @importFrom simmer get_attribute log_ release seize set_attribute timeout
-#' @importFrom simmer trajectory
-#'
 #' @return Simmer trajectory object. Defines patient journey logic through the
 #' healthcare system.
 #' @export

R/distribution_registry.R

@@ -14,10 +14,6 @@
 #'
 #' @docType class
 #'
-#' @importFrom R6 R6Class
-#' @importFrom stats rbeta rbinom rchisq rexp rgeom rgamma rlnorm rnorm rpois
-#' @importFrom stats rt runif
-#'
 #' @export
 
 DistributionRegistry <- R6Class("DistributionRegistry", list( # nolint: object_name_linter

R/filter_warmup.R

@@ -3,9 +3,6 @@
 #' @param result Named list with two tables: arrivals & occupancy.
 #' @param warm_up_period Length of warm-up period.
 #'
-#' @importFrom dplyr filter group_by ungroup
-#' @importFrom rlang .data
-#'
 #' @return The name list `result`, but with the tables (`arrivals` and
 #' `occupancy`) filtered to remove warm-up patients.
 #' @export

R/get_occupancy_stats.R

@@ -16,9 +16,6 @@
 #' @param occupancy DataFrame with three columns: \code{resource}, \code{time},
 #' and \code{occupancy}.
 #'
-#' @importFrom dplyr filter
-#' @importFrom rlang .data
-#'
 #' @return A list of data frames, one per resource, each containing occupancy
 #' statistics.
 #' @export

R/model.R

@@ -9,13 +9,6 @@ utils::globalVariables("time")
 #' may not wish to do if being set elsewhere - such as done in \code{runner()}).
 #' Default is TRUE.
 #'
-#' @importFrom dplyr filter group_by mutate rowwise ungroup
-#' @importFrom rlang .data
-#' @importFrom simmer add_resource get_mon_arrivals get_mon_resources simmer
-#' @importFrom simmer wrap
-#' @importFrom stats setNames
-#' @importFrom utils capture.output
-#'
 #' @return Named list with two tables: arrivals and occupancy.
 #' @export
 

R/parameters.R

@@ -13,8 +13,6 @@
 #' @param log_to_file Whether to save activity log to file.
 #' @param file_path Path to save log to file.
 #'
-#' @importFrom jsonlite fromJSON
-#'
 #' @return A named list of all simulation parameters.
 #' @export
 

R/runner.R

@@ -11,10 +11,6 @@
 #' documentation, which states: "Note that as.list(seq_along(x)) is not a valid
 #' set of such .Random.seed values."
 #'
-#' @importFrom dplyr bind_rows
-#' @importFrom future availableCores multisession plan sequential
-#' @importFrom future.apply future_lapply
-#'
 #' @return Named list with three tables: monitored arrivals, monitored
 #' resources, and the processed results from each run.
 #' @export

R/simulation-package.R

@@ -0,0 +1,15 @@
+#' @keywords internal
+"_PACKAGE"
+
+## usethis namespace: start
+#' @importFrom dplyr bind_rows filter group_by mutate rowwise ungroup
+#' @importFrom future availableCores multisession plan sequential
+#' @importFrom future.apply future_lapply
+#' @importFrom jsonlite fromJSON
+#' @importFrom R6 R6Class
+#' @importFrom rlang .data
+#' @importFrom simmer add_generator add_resource branch get_attribute get_mon_arrivals get_mon_resources log_ release seize set_attribute simmer timeout trajectory wrap
+#' @importFrom stats rbeta rbinom rchisq rexp rgeom rgamma rlnorm rnorm rpois rt runif setNames
+#' @importFrom utils capture.output
+## usethis namespace: end
+NULL