check.accuracy
A check that a map of classes agrees enough with a reference: the overall agreement (the share of the cells with a value in both of the same class) or Cohen's kappa at least a minimum.
| Input | Type | What it is |
|---|
maprequired | map | the map checked (a simulated or classified map) |
referencerequired | map | the reference (observed) map |
| Output | Type | What it is |
|---|
ok | bool | whether it passed (with warn; else it passed) |
| Setting | Type | What it is |
|---|
minrequired | number | the lowest agreement allowed, 0 to 1 |
measure | text | overall (default) or kappa |
message | text | what it means when it fails (the map is not accurate enough) |
warn | bool | only warn when it fails, the run going on (false) |
check.area_kept
A check that an area is kept from a map to another (a step to the next, the start to the end): the cells of a class (or, without one, the cells with a value) the same in both, up to a tolerance; with within (a protected area), every cell of it with a value keeps its class.
| Input | Type | What it is |
|---|
beforerequired | map | the map before |
afterrequired | map | the map after |
within | map | an area where no cell may change: its cells with a value |
| Output | Type | What it is |
|---|
ok | bool | whether it passed (with warn; else it passed) |
| Setting | Type | What it is |
|---|
class | number | the class whose area is kept (the cells with a value) |
tolerance | number | the cells the area may differ by (0) |
message | text | what it means when it fails (the area was not kept) |
warn | bool | only warn when it fails, the run going on (false) |
check.assert
A check that stops the run when it fails, as a test does: expression over the node's inputs in map algebra's syntax (the demand met, the areas summing to the total, the probabilities between 0 and 1); with maps among them every cell with a value must pass, else the value must be true (not 0). It fails with its message and what failed (how many cells, the value); with warn, it only warns.
| Output | Type | What it is |
|---|
ok | bool | whether it passed (with warn; else it passed) |
| Setting | Type | What it is |
|---|
expressionrequired | text | what must be true, e.g. abs(allocated - demand) < 1 |
message | text | what it means when it fails |
warn | bool | only warn when it fails, the run going on (false) |
row | integer | the row of the tables read, without maps (1) |
check.demand
A check that an allocation met its demand: the cells of each class of the demand in the map of the step equal to the demand of that step, up to a tolerance (in cells, or a share of the demand).
| Input | Type | What it is |
|---|
landscaperequired | map | the map allocated at the step |
demandrequired | demand | the cells of each class at each step |
steprequired | integer | the step (1, 2...; 0 the start) |
| Output | Type | What it is |
|---|
ok | bool | whether it passed (with warn; else it passed) |
| Setting | Type | What it is |
|---|
tolerance | number | the cells a class may differ by (0) |
relative | bool | the tolerance a share of each class's demand instead of cells (false) |
message | text | what it means when it fails (the demand was not met) |
warn | bool | only warn when it fails, the run going on (false) |
check.no_nodata
A check that a map has a value where it should: no cell without a value (NaN) in the map (every layer of a stack), or only within the cells of within that have one (the study area), up to a share of the cells allowed.
| Input | Type | What it is |
|---|
maprequired | any | the map or stack checked |
within | map | where a value is expected: its cells with a value (all) |
| Output | Type | What it is |
|---|
ok | bool | whether it passed (with warn; else it passed) |
| Setting | Type | What it is |
|---|
max_share | number | the share of the cells allowed without a value, 0 to 1 (0) |
message | text | what it means when it fails (cells have no value) |
warn | bool | only warn when it fails, the run going on (false) |
check.range
A check that every value is within a range: each cell with a value of a map (every layer of a stack), or a number, between min and max (both included); the probabilities between 0 and 1, the heights above 0.
| Input | Type | What it is |
|---|
valuerequired | any | the map, stack or number checked |
| Output | Type | What it is |
|---|
ok | bool | whether it passed (with warn; else it passed) |
| Setting | Type | What it is |
|---|
min | number | the lowest value allowed (no lower bound) |
max | number | the highest value allowed (no upper bound) |
message | text | what it means when it fails (a value is out of the range) |
warn | bool | only warn when it fails, the run going on (false) |
value.calc
A number or a text from the node's inputs, not a map: expression in map algebra's syntax and functions over the inputs that are numbers (true and false as 1 and 0), a table's value as table.column (of the row row); text a template of the inputs, {name} replaced by each one's value ({value} by the expression's): the path a loop writes (out/{species}_{year}.tif), the number a setting reads, the case of a switch.
| Output | Type | What it is |
|---|
value | number | the expression's value |
text | text | the text |
| Setting | Type | What it is |
|---|
expression | text | e.g. area / 10000, 0.3 if year < 2010 else 0.5 |
text | text | e.g. out/{species}_{year}.tif |
row | integer | the row of the tables read (1 the first, -1 the last; 1) |
