Release fireSense_ignitionPredict 1.2.0

.github/workflows/pkgdown-module.yaml

@@ -0,0 +1,30 @@
+## Thin caller: build this module's pkgdown site and publish it with GitHub Pages.
+## The job lives in PredictiveEcology/actions, so its setup and pins move once:
+## https://github.com/PredictiveEcology/actions/blob/main/.github/workflows/pkgdown-module.yaml
+## Background: PredictiveEcology/SpaDES-modules#40.
+##
+## Publishes from `development` (the pilot's choice; which branch should publish
+## is an open question on #40). Pull requests build the site without deploying.
+## The site is at https://predictiveecology.github.io/fireSense_ignitionPredict/ until a
+## custom domain is set with the `url` input.
+
+name: pkgdown-module
+
+on:
+  push:
+    branches: [development]
+  pull_request:
+    branches: [development]
+  workflow_dispatch:
+
+jobs:
+  pkgdown-module:
+    ## The called workflow's deploy job pushes to gh-pages. A called workflow can
+    ## only reduce what the caller grants, never widen it, so the write scope has
+    ## to be granted here.
+    permissions:
+      contents: write
+    uses: PredictiveEcology/actions/.github/workflows/pkgdown-module.yaml@main
+    with:
+      module: fireSense_ignitionPredict
+

.github/workflows/render-module-rmd.yaml

@@ -20,8 +20,8 @@ on:
       - development
     paths:
       - .github/workflows/render-module-rmd.yaml
-      - fireSense_IgnitionPredict.Rmd
-      - fireSense_IgnitionPredict.R
+      - fireSense_ignitionPredict.Rmd
+      - fireSense_ignitionPredict.R
   workflow_dispatch:
 
 jobs:
@@ -35,4 +35,4 @@ jobs:
       contents: write
     uses: PredictiveEcology/actions/.github/workflows/render-module-rmd.yaml@main
     with:
-      module: fireSense_IgnitionPredict
+      module: fireSense_ignitionPredict

.github/workflows/testthat-module.yaml

@@ -1,5 +1,5 @@
 ## Example caller for the testthat-module reusable workflow.
-## Replace fireSense_IgnitionPredict with the module name (which must match the repository name).
+## Replace fireSense_ignitionPredict with the module name (which must match the repository name).
 
 name: testthat-module
 
@@ -10,7 +10,7 @@ on:
     branches: [main, master, development]
     paths:
       - .github/workflows/testthat-module.yaml
-      - fireSense_IgnitionPredict.R
+      - fireSense_ignitionPredict.R
       - R/**
       - tests/**
   workflow_dispatch:
@@ -22,4 +22,4 @@ jobs:
     ## itself is all it needs.
     uses: PredictiveEcology/actions/.github/workflows/testthat-module.yaml@main
     with:
-      module: fireSense_IgnitionPredict
+      module: fireSense_ignitionPredict

.gitignore

@@ -5,5 +5,5 @@
 .DS_Store
 .quarto
 
-fireSense_IgnitionPredict_cache/
-fireSense_IgnitionPredict2.Rmd
+fireSense_ignitionPredict_cache/
+fireSense_ignitionPredict2.Rmd

NEWS.md

@@ -1,3 +1,37 @@
+# fireSense_ignitionPredict 1.2.0
+
+This release fixes two errors that changed how many fires the module predicted. Weather and landscape conditions are now compared against the conditions the model was fitted on; before, each year was compared only with itself, so every year looked average to the model and hot or dry years did not stand out. And when several fires started in the same area, the module could count more escaped fires than actually escaped; each escape is now counted once. Results will differ from earlier versions, and should be more realistic.
+
+The module also has a new name, `fireSense_ignitionPredict` (lower-case "i"), so projects need to update the name they use for it. It can now use a separate fitted model for each region (ELF) of a study area, runs faster on large maps, and has automated tests and a documentation website.
+
+- The coarse-to-fine cell mapping of the ignition raster is computed once and kept in `mod`, then applied each year by indexing, instead of regridding the raster to `flammableRTM` with `postProcess()` every year (about 3 s a year at 6.7M fine cells). It is rebuilt if the extent, dimensions or crs of `ignitionFitRTM` or `flammableRTM` change. Ignitions and escapes are unchanged.
+
+# fireSense_ignitionPredict 1.1.1
+
+- reqdPkgs now lists `data.table` and `reproducible`, which the module calls (`:=`, `copy`, `set`, `setnames`, `rbindlist`, `as.data.table`, `postProcess`) but did not list. Version 1.1.1.
+
+# fireSense_ignitionPredict 1.1.0
+
+- Renamed from `fireSense_IgnitionPredict` to `fireSense_ignitionPredict` (module naming convention `<model>_<camelCaseComponent>`); projects must rename the module and its `params` key. The class `fireSense_IgnitionFit` and the objects `fireSense_IgnitionFitted`, `fireSense_IgnitionFittedList` and `fireSense_IgnitionPredicted` keep their names. Version 1.1.0.
+
+- `ignitionsAndEscapes` gains `escaped`: whether each ignition escaped, with exactly `escapes` of a coarse
+  pixel's ignitions TRUE. `escapes` is the coarse pixel's count, repeated on each of its ignitions, and fireSense
+  spread `escapes` fires from every one of them, so a coarse pixel with 4 ignitions and 2 escapes gave 8 escaped
+  fires instead of 2. Version 1.0.0.9003.
+
+- New parameter `.studyAreaName` (default `NA`), the name PredictiveEcology modules use for the study area. This module does not use it yet.
+- Several fitted ELFs in one study area: with `fireSense_IgnitionFittedList` and `fireSense_EscapeFittedList` (one fit per ELF, named by `ELFind`) and `rasterToMatchLargeELF`, each ELF's models predict the coarse pixels of that ELF, with its own `scaleData`. The Poisson and binomial draws are still made once over all pixels, so one ELF gives exactly the previous result.
+
+# fireSense_IgnitionPredict (development version)
+
+## Bug fixes
+
+- Covariates are now standardized with the center and scale stored by the fit (`fireSense_IgnitionFitted$scaleData`, `fireSense_EscapeFitted$scaleData`). They were standardized with each year's own mean and sd, so every year looked average to the models. With `rescaleVars = TRUE`, a fitted object without `scaleData` is now an error.
+
+## Cleanup
+
+- The `save` event now does nothing and says so. It used to fail, because it wrote `sim$fireSense_IgnitionPredicted`, which the module no longer creates. `IgnitionPredictSave()` is removed.
+
 # fireSense_IgnitionPredict 1.0.0
 
 First release from `development` since `master` was last updated (2021-03-11). Full history: https://github.com/PredictiveEcology/fireSense_IgnitionPredict/compare/5a242fa...v1.0.0

README.md

@@ -1 +1 @@
-fireSense_IgnitionPredict.md
+fireSense_ignitionPredict.md

citation.bib

@@ -1,6 +1,6 @@
 
 @Manual{,
-  title = {fireSense_IgnitionPredict},
+  title = {fireSense_ignitionPredict},
   author = {{Authors}},
   organization = {Organization},
   address = {Somewhere, Someplace},