Skip to content

Commit c21511a

Browse files
committed
ignore_nan added to documentation CombineResultsRule
1 parent b986740 commit c21511a

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

docs/manual/rules/combine_results_rule.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ FORMAT
88
operation: <statistic_opperation_applied>
99
input_variables: [<list with_input_variable_names>]
1010
output_variable: <one_output_variable_name>
11+
ignore_nan: <boolean>
1112
```
1213

13-
The combine results rule combines the output of two or more variables to one output variable. The way this data is combined depends on the operation chosen. This could be used for adding mutual exclusive results (e.g., habitat suitability based on flow velocity and water depth) or assessing difference between results (e.g., waterlevel and bathymetry to get the water depth).The rule operates one or multiple 3D variables or 2D variables, independent of the time axes, as long as these all have the same dimensions and returns a single 3D or 2D result, either with time axis, depending on input.
14+
The combine results rule combines the output of two or more variables to one output variable. The way this data is combined depends on the operation chosen. This could be used for adding mutual exclusive results (e.g., habitat suitability based on flow velocity and water depth) or assessing difference between results (e.g., waterlevel and bathymetry to get the water depth). The rule operates one or multiple 3D variables or 2D variables, independent of the time axes, as long as these all have the same dimensions and returns a single 3D or 2D result, either with time axis, depending on input.
1415

1516
Operations available: Add, Subtract, Multiply, Average, Median, Min and Max
17+
The parameter ignore_nan is optional and has a default value of False. When this parameter is set to True, empty values (NaN) will be ignored for all operations, except for Multiply.
1618

1719
The rule needs to be applied to an existing 2D/3D variables with or without time axis. A new 2D/3D variable with or without time axis is created when the rule is executed.
1820

@@ -26,6 +28,7 @@ The rule needs to be applied to an existing 2D/3D variables with or without time
2628
operation: subtract
2729
input_variables: ["water_level","water_depth"]
2830
output_variable: bathymetry_time
31+
ignore: True
2932
3033
```
3134

0 commit comments

Comments
 (0)