apply_data_var_reduction#
- rojak.core.calculations.apply_data_var_reduction(data: Dataset, method_name: XrAggregationMethod, *, new_dim: str = 'ensemble', var_name: str = 'ensemble', append: Literal[False], **kwargs: Any) DataArray[source]#
- rojak.core.calculations.apply_data_var_reduction(data: Dataset, method_name: XrAggregationMethod, *, new_dim: str = 'ensemble', var_name: str = 'ensemble', append: Literal[True] = True, **kwargs: Any) Dataset
Aggregates over data variables of a data set.
- Parameters:
data (Dataset) – Dataset to perform aggregation on
method_name (XrAggregationMethod) – Name of the aggregation method
new_dim (str) – Name of the new dimension to aggregate over
var_name (str) – Name of the new variable in dataset or name of the aggregated data array
append (bool) – When True, appends aggregated data array to dataset. Otherwise, returns aggregated data array
**kwargs (Any) – Kwargs (excluding dim kwarg) to aggregating method. See Xarray API docs.
- Returns:
Aggregated data array or data set
- Return type: