Migrating from the individual modules
+
Children are listed by name, so each comes from the parent’s GitHub account and branch: PredictiveEcology/fireSense@development fetches every child’s development branch, and PredictiveEcology/fireSense@main every child’s main. A child written with a branch (fireSense_summary@modsForFireSense) or an account keeps it. A module the user lists in setupProject(modules = ) overrides the parent’s entry for it, e.g. c("PredictiveEcology/fireSense@development", "PredictiveEcology/fireSense_burn@testing").
To migrate: list PredictiveEcology/fireSense@development in setupProject(modules = ...) instead of the individual fireSense modules, and rename these params keys (and whichModulesToPrepare values). fireSense now means the whole family; the burn module is fireSense_burn.
diff --git a/fireSense.md b/fireSense.md
index 12eebe3..0ac92d2 100644
--- a/fireSense.md
+++ b/fireSense.md
@@ -1,7 +1,7 @@
---
title: "fireSense Manual"
-subtitle: "v.1.0.0"
-date: "Last updated: 2026-09-29"
+subtitle: "v.1.1.0"
+date: "Last updated: 2026-10-08"
output:
bookdown::html_document2:
toc: true
@@ -54,20 +54,22 @@ SpaDES.project::setupProject(
### Child modules
-|child |
-|:-------------------------------------------------------|
-|PredictiveEcology/fireSense_ELFs@development |
-|PredictiveEcology/fireSense_dataPrepFit@development |
-|PredictiveEcology/fireSense_ignitionFit@development |
-|PredictiveEcology/fireSense_spreadFit@development |
-|PredictiveEcology/fireSense_dataPrepPredict@development |
-|PredictiveEcology/fireSense_ignitionPredict@development |
-|PredictiveEcology/fireSense_spreadPredict@development |
-|PredictiveEcology/fireSense_burn@development |
-|PredictiveEcology/fireSense_summary@modsForFireSense |
+|child |
+|:----------------------------------|
+|fireSense_ELFs |
+|fireSense_dataPrepFit |
+|fireSense_ignitionFit |
+|fireSense_spreadFit |
+|fireSense_dataPrepPredict |
+|fireSense_ignitionPredict |
+|fireSense_spreadPredict |
+|fireSense_burn |
+|fireSense_summary@modsForFireSense |
### Migrating from the individual modules
+Children are listed by name, so each comes from the parent's GitHub account and branch: `PredictiveEcology/fireSense@development` fetches every child's `development` branch, and `PredictiveEcology/fireSense@main` every child's `main`. A child written with a branch (`fireSense_summary@modsForFireSense`) or an account keeps it. A module the user lists in `setupProject(modules = )` overrides the parent's entry for it, e.g. `c("PredictiveEcology/fireSense@development", "PredictiveEcology/fireSense_burn@testing")`.
+
To migrate: list `PredictiveEcology/fireSense@development` in `setupProject(modules = ...)` instead of the individual fireSense modules, and rename these `params` keys (and `whichModulesToPrepare` values). `fireSense` now means the whole family; the burn module is `fireSense_burn`.
| old module name | new module name |
diff --git a/tests/testthat/test-metadata.R b/tests/testthat/test-metadata.R
index 78abc52..6b6c692 100644
--- a/tests/testthat/test-metadata.R
+++ b/tests/testthat/test-metadata.R
@@ -4,15 +4,15 @@
md <- SpaDES.core::moduleMetadata(module = moduleName, path = modulePath)
childSpecs <- c(
- "PredictiveEcology/fireSense_ELFs@development",
- "PredictiveEcology/fireSense_dataPrepFit@development",
- "PredictiveEcology/fireSense_ignitionFit@development",
- "PredictiveEcology/fireSense_spreadFit@development",
- "PredictiveEcology/fireSense_dataPrepPredict@development",
- "PredictiveEcology/fireSense_ignitionPredict@development",
- "PredictiveEcology/fireSense_spreadPredict@development",
- "PredictiveEcology/fireSense_burn@development",
- "PredictiveEcology/fireSense_summary@modsForFireSense"
+ "fireSense_ELFs",
+ "fireSense_dataPrepFit",
+ "fireSense_ignitionFit",
+ "fireSense_spreadFit",
+ "fireSense_dataPrepPredict",
+ "fireSense_ignitionPredict",
+ "fireSense_spreadPredict",
+ "fireSense_burn",
+ "fireSense_summary@modsForFireSense"
)
childNames <- c("fireSense_ELFs", "fireSense_dataPrepFit", "fireSense_ignitionFit",
"fireSense_spreadFit", "fireSense_dataPrepPredict", "fireSense_ignitionPredict",
@@ -21,7 +21,13 @@ childNames <- c("fireSense_ELFs", "fireSense_dataPrepFit", "fireSense_ignitionFi
test_that("metadata parses and names the parent", {
expect_identical(md$name, "fireSense")
expect_identical(md$timeunit, "year")
- expect_identical(md$version$fireSense, "1.0.0")
+ expect_false(is.na(package_version(md$version$fireSense, strict = FALSE)))
+})
+
+test_that("the version list names a valid version for every child", {
+ ## SpaDES.project fetches a child of fireSense@v at v
+ expect_true(all(childNames %in% names(md$version)))
+ expect_false(anyNA(package_version(unlist(md$version[childNames]), strict = FALSE)))
})
test_that("a parent has no parameters, inputs or outputs", {