gemmr.sample_size.interpolation.calc_n_required_all_metrics¶
-
gemmr.sample_size.interpolation.
calc_n_required_all_metrics
(ds, target_power=0.9, target_error=0.1, search_dim='n')¶ Calculate n_required for 5 commonly used metrics, as well as maximum across metrics.
Required sample sizes are calculated with
calc_n_required()
.Used metrics are power,
metrics.mk_betweenAssocRelError()
,metrics.mk_weightError()
,metrics.mk_scoreError()
, andmetrics.mk_loadingError()
NOTE: removed “.sel(mode=0)” and “.dropna(‘iter’, ‘all’)”
Parameters: - ds (
xr.Dataset
) – dataset on which metrics will be computed. - target_power (float between 0 and 1) – minimum acceptable power
- target_error (float between 0 and 1) – maximum accepted error
Returns: all_n_requireds – entries are
xr.DataArray
s giving required sample sizesReturn type: dict
- ds (