class

Author: jenniferxu1101

R/est_s_t_y.R

@@ -120,7 +120,7 @@ SIM <- function(X, Y, kernel, method, single_index_method, use_mave){
 #' @param coef_M_R1.fit Optional starting coefficients for missingness model fit
 #'   in `R = 1` stratum.
 #'
-#' @return A named list of estimates and uncertainty summaries for each value in
+#' @return A named list of class `est_psi` that contains estimates and uncertainty summaries for each value in
 #'   `gamma`. Core elements include point estimates (`est`, `est_R1`, `est_R0`), variance
 #'   estimates (`var`, `var_R1`, `var_R0`), and confidence interval bounds (`lowerCI*`, `upperCI*`). 
 #'   Additional components depend on `simple_trunc` and `IF_output`:
@@ -144,6 +144,7 @@ SIM <- function(X, Y, kernel, method, single_index_method, use_mave){
 #' #                simple_trunc = TRUE, quant = 0.99, kernel="dnorm", 
 #' #                single_index_method="norm1coef", method="optim")
 #' @export
+#' @rdname est_psi
 est_psi <- function(Y, M, R, X, t, trt, gamma, fold, seed, IF_output, 
                     simple_trunc, quant, kernel, single_index_method, method="optim", 
                     use_mave=TRUE, s_t_y=NULL, coef_g.fit=NULL, coef_t_R0.fit=NULL, 
@@ -616,21 +617,25 @@ est_psi <- function(Y, M, R, X, t, trt, gamma, fold, seed, IF_output,
     }
   }else{
     if(simple_trunc){
-      result <- list(est=r_est, est_R1=r_est_R1, est_R0=r_est_R0, 
-                     var=r_var, var_R1=r_var_R1, var_R0=r_var_R0, 
-                     lowerCI=r_lowerCI, lowerCI_R1=r_lowerCI_R1, lowerCI_R0=r_lowerCI_R0, 
-                     upperCI=r_upperCI, upperCI_R1=r_upperCI_R1, upperCI_R0=r_upperCI_R0, 
-                     id_list=containers$id_list, fold_index_l=fold_index_l)
+      result <- structure(
+        list(est=r_est, est_R1=r_est_R1, est_R0=r_est_R0, 
+             var=r_var, var_R1=r_var_R1, var_R0=r_var_R0, 
+             lowerCI=r_lowerCI, lowerCI_R1=r_lowerCI_R1, lowerCI_R0=r_lowerCI_R0, 
+             upperCI=r_upperCI, upperCI_R1=r_upperCI_R1, upperCI_R0=r_upperCI_R0, 
+             id_list=containers$id_list, fold_index_l=fold_index_l), 
+        class = c("est_psi"))
     }else{
-      result <- list(est=r_est, est_R1=r_est_R1, est_R0=r_est_R0, 
-                     est_trunc=r_est_trunc, est_trunc_R1=r_est_trunc_R1, est_trunc_R0=r_est_trunc_R0,
-                     var=r_var, var_R1=r_var_R1, var_R0=r_var_R0,
-                     var_trunc=r_var_trunc, var_trunc_R1=r_var_trunc_R1, var_trunc_R0=r_var_trunc_R0,
-                     lowerCI=r_lowerCI, lowerCI_R1=r_lowerCI_R1, lowerCI_R0=r_lowerCI_R0,
-                     upperCI=r_upperCI, upperCI_R1=r_upperCI_R1, upperCI_R0=r_upperCI_R0,
-                     lowerCI_trunc=r_lowerCI_trunc, lowerCI_trunc_R1=r_lowerCI_trunc_R1, lowerCI_trunc_R0=r_lowerCI_trunc_R0,
-                     upperCI_trunc=r_upperCI_trunc, upperCI_trunc_R1=r_upperCI_trunc_R1, upperCI_trunc_R0=r_upperCI_trunc_R0,
-                     id_list=containers$id_list, fold_index_l=fold_index_l)
+      result <- structure(
+        list(est=r_est, est_R1=r_est_R1, est_R0=r_est_R0, 
+             est_trunc=r_est_trunc, est_trunc_R1=r_est_trunc_R1, est_trunc_R0=r_est_trunc_R0,
+             var=r_var, var_R1=r_var_R1, var_R0=r_var_R0,
+             var_trunc=r_var_trunc, var_trunc_R1=r_var_trunc_R1, var_trunc_R0=r_var_trunc_R0,
+             lowerCI=r_lowerCI, lowerCI_R1=r_lowerCI_R1, lowerCI_R0=r_lowerCI_R0,
+             upperCI=r_upperCI, upperCI_R1=r_upperCI_R1, upperCI_R0=r_upperCI_R0,
+             lowerCI_trunc=r_lowerCI_trunc, lowerCI_trunc_R1=r_lowerCI_trunc_R1, lowerCI_trunc_R0=r_lowerCI_trunc_R0,
+             upperCI_trunc=r_upperCI_trunc, upperCI_trunc_R1=r_upperCI_trunc_R1, upperCI_trunc_R0=r_upperCI_trunc_R0,
+             id_list=containers$id_list, fold_index_l=fold_index_l), 
+        class = c("est_psi"))
     }
   }