gemmr.data.load_outcomes

gemmr.data.load_outcomes(model, estr=None, tag=None, data_home=None, fetch=True)

Load previously generated outcome data.

Loads the file {data_home}/synthanad_{model}_{estr}[_{tag}].nc

Parameters:
  • model (str) – ‘’cca’’ or ‘’pls’‘
  • estr (None or str) – name of estimator used to analyzed the data, defaults to model
  • tag (None or str) – possibly an additional tag to identify the outcome file, defaults to an empty string
  • data_home (None or str) – folder in which outcome data resides, if None defaults to ~/gemmr_data
  • fetch (bool) – if True and data is not found in data_home attempts to retrieve it from repository
Returns:

data – outcome dataset

Return type:

xr.Dataset