diff --git a/CHANGES.rst b/CHANGES.rst index 809101550..dd83cfc13 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -45,6 +45,7 @@ Bug fixes * Fix wrong `window` attributes in ``xclim.indices.standardized_precipitation_index``, ``xclim.indices.standardized_precipitation_evapotranspiration_index``. (:issue:`1552` :pull:`1554`). * Fix the daily case `freq='D'` of ``xclim.stats.preprocess_standardized_index`` (:issue:`1602` :pull:`1607`). * Several spelling mistakes have been corrected within the documentation and codebase. (:pull:`1576`). +* Added missing ``xclim.ensembles.robustness_fractions`` and ``xclim.ensembles.robistness_categoris`` in api doc section. (:pull:`1630`). Internal changes ^^^^^^^^^^^^^^^^ diff --git a/docs/api.rst b/docs/api.rst index ab78a2716..8c4f5d60e 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -53,6 +53,12 @@ Ensembles Module .. automodule:: xclim.ensembles._robustness :noindex: +.. autofunction:: xclim.ensembles.robustness_fractions + :noindex: + +.. autofunction:: xclim.ensembles.robustness_categories + :noindex: + .. autofunction:: xclim.ensembles.change_significance :noindex: diff --git a/xclim/ensembles/_robustness.py b/xclim/ensembles/_robustness.py index 9d83d5371..00e9f1b1b 100644 --- a/xclim/ensembles/_robustness.py +++ b/xclim/ensembles/_robustness.py @@ -3,8 +3,8 @@ =========================== Robustness metrics are used to estimate the confidence of the climate change signal of an ensemble. -This submodule is inspired by and tries to follow the guidelines of the IPCC, more specifically -the 12th chapter of the Working Group 1's contribution to the AR5 :cite:p:`collins_long-term_2013` (see box 12.1). +This submodule is inspired by and tries to follow the guidelines of the IPCC, +more specifically :cite:p:`collins_long-term_2013` (AR5) and :cite:cts:`ipccatlas_ar6wg1` (AR6). """ from __future__ import annotations @@ -101,6 +101,8 @@ def robustness_fractions( # noqa: C901 pvals : The p-values estimated by the significance tests. Only returned if the test uses `pvals`. Has the `realization` dimension. + Notes + ----- The table below shows the coefficient needed to retrieve the number of members that have the indicated characteristics, by multiplying it by the total number of members (`fut.realization.size`) and by `valid_frac`, assuming uniform weights. @@ -116,8 +118,6 @@ def robustness_fractions( # noqa: C901 | Negative change | (cf - cpf) | 1 - pf - (cf -cpf) | 1 - pf | +-----------------+--------------------+------------------------+------------+ - Notes - ----- Available statistical tests are : {tests_doc} @@ -649,7 +649,7 @@ def _gen_test_entry(namefunc): return f"\t{name}:\n\t\t{doc}" -change_significance.__doc__ = change_significance.__doc__.format( +robustness_fractions.__doc__ = robustness_fractions.__doc__.format( tests_list="{" + ", ".join(list(SIGNIFICANCE_TESTS.keys()) + ["threshold"]) + "}", tests_doc="\n".join(map(_gen_test_entry, SIGNIFICANCE_TESTS.items())), )