gemmr.data.load_outcomes

gemmr.data.load_outcomes(dsid, model=None, data_home=None, fetch=True, add_prefix=False)

Load previously generated outcome data.

Loads the file {data_home}/{dsid}.nc

Parameters:

  • dsid (str) – Descriptor for dataset to load.

  • model (str) – ‘’cca’’ or ‘’pls’’

  • 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

  • add_prefix (bool) – if True, data variables in dataset are prefixed with model unless they already start with other_model where other_model is set to “cca” if model == "pls", or to “pls” if model == "cca".

Returns:

data – outcome dataset

Return type:

xr.Dataset