version 1.1.2

DESCRIPTION

@@ -1,16 +1,16 @@
 Package: SPLICE
 Title: Synthetic Paid Loss and Incurred Cost Experience (SPLICE)
         Simulator
-Version: 1.1.1
+Version: 1.1.2
 Authors@R: c(
     person("Benjamin", "Avanzi", role = "aut", email = "b.avanzi@unimelb.edu.au"),
     person("Greg", "Taylor", role = "aut", email = "greg_taylor60@hotmail.com"),
     person("Melantha", "Wang", role = c("aut", "cre"), email = "wang.melantha@gmail.com"),
-    person("William", "Ho", role = "rev"))
+    person("William", "Ho", role = "aut", email = "ho.w@unimelb.edu.au"))
 Author: Benjamin Avanzi [aut],
   Greg Taylor [aut],
   Melantha Wang [aut, cre],
-  William Ho [rev]
+  William Ho [aut]
 Maintainer: Melantha Wang <wang.melantha@gmail.com>
 Imports: stats, methods, zoo, lifecycle
 Description: An extension to the individual claim simulator called 'SynthETIC'
@@ -29,11 +29,11 @@ Encoding: UTF-8
 URL: https://github.com/agi-lab/SPLICE
 BugReports: https://github.com/agi-lab/SPLICE/issues
 LazyData: true
-RoxygenNote: 7.1.2
+RoxygenNote: 7.3.1
 Suggests: knitr, rmarkdown, dplyr, RColorBrewer, actuar
 VignetteBuilder: knitr
 Depends: R (>= 2.10), SynthETIC (>= 1.0.0)
 NeedsCompilation: no
-Packaged: 2023-04-16 00:06:29 UTC; melantha
+Packaged: 2024-01-27 13:30:05 UTC; melantha
 Repository: CRAN
-Date/Publication: 2023-04-16 07:40:09 UTC
+Date/Publication: 2024-02-04 00:30:02 UTC

MD5

@@ -1,12 +1,12 @@
-3642a11ffaabc59a374e5364ef2bcaf9 *DESCRIPTION
+b02e03f32b27b8149976d5139f3d5d81 *DESCRIPTION
 f149d4eaf1387690a5c5cabc1d9f7f5f *NAMESPACE
-3fe77aa03998624af5c322e54491aa5b *NEWS.md
+489a3d8a4c6b9a7e784c3669852ecb2a *NEWS.md
 1afae3bb0092d85adeeb367d137890cb *R/SPLICE-package.R
 0fa41bcd0b292873d6c3793370fa11b5 *R/data.R
 7667997f5c53c9e79971feabb93e3607 *R/features_09_major_revisions.R
 9ce62b0799ac05cf3bda74d6d2d4c5a6 *R/features_10_minor_revisions.R
 a62897149c75b811c1b06d4f49351164 *R/features_11_incurred_history.R
-20bbfb5a9530e278b38252704c223e4b *R/generate_data.R
+ed82c63a0ac7b8586c1fee8154f1794e *R/generate_data.R
 9940413e9f941af11c7a5bdcd9dd1e76 *R/output_incurred.R
 2dd41d8672d2f7fb997faa09c7148363 *R/stats.R
 5f8cd825906fb362d09555f856507282 *build/vignette.rds
@@ -16,7 +16,7 @@ a62897149c75b811c1b06d4f49351164 *R/features_11_incurred_history.R
 34989c3c228d572916b93eddad4173bb *inst/doc/SPLICE-demo.R
 d270554cba357d1a134ddbe82751b2bf *inst/doc/SPLICE-demo.Rmd
 35cfb16e5f7edad226b939caa62d5879 *inst/doc/SPLICE-demo.html
-5fd8cff9700353caf492e6ae949ff58d *man/SPLICE-package.Rd
+a2e31fd177c9d08f8500661c6695d320 *man/SPLICE-package.Rd
 a4bbe4b39487ac0e4bad93a3865c7ee6 *man/claim_history.Rd
 e2ba8c726fcad86a3e54e1ccb0941d4d *man/claim_majRev.Rd
 20f8369feccf2cff182a034219d857eb *man/claim_minRev.Rd
@@ -28,7 +28,7 @@ c3978703d8f40f2679795335715e98f4 *man/figures/lifecycle-experimental.svg
 27b879bf3677ea76e3991d56ab324081 *man/figures/lifecycle-questioning.svg
 53b3f893324260b737b3c46ed2a0e643 *man/figures/lifecycle-stable.svg
 1c1fe7a759b86dc6dbcbe7797ab8246c *man/figures/lifecycle-superseded.svg
-6bbea2f6049eefb1c387af18e983864a *man/generate_data.Rd
+7c29e3c4e23f82f6159e5e68c05fd0e6 *man/generate_data.Rd
 b1e2e2c640d519773dcf2e0b26d1dbf9 *man/generate_incurred_dataset.Rd
 5deeeb1980177e0d1cbc1918232c4cbc *man/output_incurred.Rd
 9389266bf2d5fb37bf4912f5cc65001b *man/test_incurred_dataset.Rd

NEWS.md

@@ -1,5 +1,13 @@
 # SPLICE
 
+# SPLICE 1.1.2
+
+## Minor improvements and fixes 
+
+* Update `generate_data` function and included new `test_incurred_datasets_` to 
+complement the inclusion of the `claim_covariates` sub-module in `SynthETIC` 
+version 1.1.0.
+
 # SPLICE 1.1.1
 
 ## Minor improvements and fixes 

R/generate_data.R

@@ -207,6 +207,7 @@ get_params <- function(complexity) {
 #' @param random_seed optional seed for random number generation for
 #' reproducibility.
 #' @param verbose logical; if `TRUE` print a message about the data generated.
+#' @param covariates_obj a SynthETIC \code{\link[SynthETIC]{covariates}} object (requires `SynthETIC >= 1.1.0`). Defaults to `NULL`.
 #'
 #' @details `generate_data()` produces datasets of varying levels of complexity,
 #' where 1 represents the simplest, and 5 represents the most complex:
@@ -238,7 +239,9 @@ get_params <- function(complexity) {
 #' case estimates change over time. Takes the same structure as
 #' \code{\link{test_incurred_dataset}}, with each row representing a transaction
 #' (any of claim notification, settlement, a payment, or a case estimate
-#' revision).
+#' revision). \cr
+#' `covariates_data` \tab Only if `covariates_obj` is not NULL, in which case
+#' it will return a SynthETIC \code{\link[SynthETIC]{covariates_data}} object.
 #' }
 #'
 #' @seealso \code{\link[SynthETIC]{generate_claim_dataset}},
@@ -273,7 +276,8 @@ generate_data <- function(
   complexity = c(1:5),
   data_type = c("claims", "payments", "incurred"),
   random_seed = NULL,
-  verbose = TRUE
+  verbose = TRUE,
+  covariates_obj = NULL
 ) {
 
   # match.arg only works with chars
@@ -313,6 +317,13 @@ generate_data <- function(
 
   # M2: Claim size (constant dollar values)
   claim_sizes <- claim_size(freq_vector)
+  # M2a: Simulation of Covariates
+  if (!is.null(covariates_obj) & isa(covariates_obj, "covariates")) {
+    claim_size_covariates <- claim_size_adj(covariates_obj, claim_sizes)
+    covariates_data_obj <- claim_size_covariates$covariates_data
+    claim_sizes <- claim_size_covariates$claim_size_adj
+    output$covariates_data <- covariates_data_obj
+  }
 
   # M3: Claim notification
   ntfy_delays <- claim_notification(