gemmr.sample_size.linear_model.get_lm_coefs

gemmr.sample_size.linear_model.get_lm_coefs(model, criterion, target_error, target_power, data_home)

Get linear model coefficients.

For default parameters, i.e. if criterion='combined', target_power=0.9 and target_error=0.1, coefficients are read from file '../datasets/sample_size_lm_[model].csv'. Otherwise, they are calculated from outcome datasets.

Parameters:

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

• criterion (str) –

  Can be:

  • 'combined'

  • 'power'

  • 'association_strength'

  • 'weight'

  • 'score'

  • 'loading'

  • 'crossloading'

• target_error (float between 0 and 1) – target error level

• target_power (float between 0 and 1) – target power level

• data_home (None or str) – path where outcome data are stored, None indicates default path

Returns:

• intercept (float) – linear model intercept

• coefs (np.ndarray) – linear model coefficients