semver(sdt): v0.1.3 (#286)

* semver(sdt): v0.1.3 * doc: change gainloss
PoisotLab · Sep 28, 2024 · b6bf5ee · b6bf5ee · tpoisot · Sep 28, 2024
1 parent 1759419
commit b6bf5ee
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 3 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "SpeciesDistributionToolkit"
 uuid = "72b53823-5c0b-4575-ad0e-8e97227ad13b"
 authors = ["Timothée Poisot <timothee.poisot@umontreal.ca>"]
-version = "0.1.2"
+version = "0.1.3"
 
 [deps]
 Distances = "b4f34e82-e78d-54a5-968a-f98e89d6e8f7"

diff --git a/docs/make.jl b/docs/make.jl
@@ -87,6 +87,7 @@ makedocs(;
             "manual/pseudoabsences.md",
             "manual/polygons.md",
             "manual/gadm.md",
+            "manual/utilities.md"
         ],
     ],
 )

diff --git a/docs/src/manual/utilities.md b/docs/src/manual/utilities.md
@@ -0,0 +1,5 @@
+# Other utility functions
+
+```@docs
+gainloss
+```
diff --git a/docs/src/tutorials/sdemo.jl b/docs/src/tutorials/sdemo.jl
@@ -122,7 +122,7 @@ prd = predict(sdm, layers; threshold = false)
 # Decision trees, in oredr to avoid overfitting, are pretty small -- indeed, the
 # default version in `SDeMo` is capped at 12 nodes, with a maximal depth of 7.
 # This is because there is no limit to how much decision trees can overfit. But
-# as a result, the map representing these predictions can look a little coase:
+# as a result, the map representing these predictions can look a little coarse:
 
 # fig-initial-map
 f = Figure(; size = (600, 300))

diff --git a/src/utilities.jl b/src/utilities.jl
@@ -2,7 +2,9 @@
     gainloss(contemporary::SDMLayer{Bool}, future::SDMLayer{Bool})
 
 Returns a layer with values -1, 0, and 1 corresponding to the difference in
-ranges.
+ranges. The two layers given as input must be layers with boolean values where
+`true` indicates that the pixel is in the range. The presence of `false` pixels
+is irrelevant as these are ignored internally.
 """
 function gainloss(contemporary::SDMLayer{Bool}, future::SDMLayer{Bool})
     rangemask = nodata((contemporary)|(future), false)