Learn R Programming

Surrogate (version 3.3.3)

association_gof_copula: Produce Associational GoF plot

Description

Produce Associational GoF plot

Usage

association_gof_copula(
  fitted_submodel,
  treat,
  endpoint_types,
  return_data = FALSE,
  grid = NULL,
  ...
)

Arguments

fitted_submodel

List returned by fit_copula_submodel_OrdCont(), fit_copula_submodel_ContCont(), or fit_copula_submodel_OrdOrd().

treat

Value for the treatment indicator.

endpoint_types

Character vector with 2 elements indicating the type of endpoints. Each element is either "ordinal" or "continuous".

return_data

(boolean) Return the data used in the goodness-of-fit plot (without the plot itself). This is useful when the user wants to customize the plots, e.g., using ggplot2. See Details.

grid

(numeric) vector of values for the (surrogate) endpoint at which the regression function is evaluated.

...

Extra argument passed onto plot().

Semi-Parametric Regression estimates

See the documentation of plot.vine_copula_fit() for the default semi-parametric estimators.

Return Plotting Data

If return_data is TRUE, this function will return a data frame that can be used to create customized plots. The following variables are present in the returned data frame:

  • observed: The semi-parametric estimate of the regression function $$E(T | S)$$.

  • upper_ci, lower_ci: Upper and lower limit of the pointwise 95% confidence interval for the semi-parametric estimate of the regression function.

  • value: Value for the surrogate endpoint at which the estimates for the regression function are evaluated.

  • model_based: Model-based estimate of the regression function.

See Also

plot.vine_copula_fit()