Skip to contents

Prediction component from logit models (non mixed) called in Policy3, under predict_model_tempNew.m

Usage

logit_predict(
  project,
  mod.name,
  use.scalers = FALSE,
  scaler.func = NULL,
  outsample = FALSE,
  outsample.mod.name = NULL
)

Arguments

project

Name of project

mod.name

Name of saved model to use. Argument can be the name of the model or can pull the name of the saved "best" model. Leave mod.name empty to use the saved "best" model. If more than one model is saved, mod.name should be the numeric indicator of which model to use. Use table_view("modelChosen", project) to view a table of saved models.

use.scalers

Input for create_model_input(). Logical, should data be normalized? Defaults to FALSE. Rescaling factors are the mean of the numeric vector unless specified with scaler.func.

scaler.func

Input for create_model_input(). Function to calculate rescaling factors.

outsample

Logical, FALSE if predicting probabilities for main data, and TRUE if predicting for out-of-sample data. outsample = FALSE is the default setting.

outsample.mod.name

If predicting out-of-sample data, provide the out-of-sample model design name. outsample.mod.name = NULL by default.

Value

Returns probability of logit model by choice