add R package

Author: kimmo1019

r-package/RcausalEGM/.Rbuildignore

@@ -0,0 +1,2 @@
+^.*\.Rproj$
+^\.Rproj\.user$

r-package/RcausalEGM/.gitignore

@@ -0,0 +1,4 @@
+.Rproj.user
+.Rhistory
+.RData
+.Ruserdata

r-package/RcausalEGM/DESCRIPTION

@@ -0,0 +1,14 @@
+Package: RcausalEGM
+Type: Package
+Title: A General Causal Inference Framework by Encoding Generative Modeling
+Version: 0.1.0
+Date: 2023-02-14
+Author: Qiao Liu
+Maintainer: Qiao Liu <[email protected]>
+Description: CausalEGM is a general causal inference framework for estimating causal effects by encoding generative modeling, which can be applied in both discrete and continuous treatment settings. A description of the methods is given in Liu (2022) <https://arxiv.org/abs/2212.05925>.
+License: MIT + file LICENSE
+Encoding: UTF-8
+LazyData: true
+Imports: reticulate
+Repository: CRAN
+Depends: R(>= 3.6.3)

r-package/RcausalEGM/NAMESPACE

@@ -0,0 +1 @@
+exportPattern(causalegm)

r-package/RcausalEGM/R/causalegm.R

@@ -0,0 +1,71 @@
+#' @title Main function for CausalEGM to estimate causal effect in either binary or continuous treatment settings.
+#'
+#' @description This function takes observation data (x,y,v) as input, and estimate the ATE/ITE/ADRF.
+#'
+#' @param X is the treatment variable.
+#' @param Y is the potential outcome.
+#' @param V is the covariates.
+#' @param yaml_file is the deployment file for initializing a CausalEGM instance.
+#'
+#'
+#' @return NULL
+#'
+#' @examples causalegm(X=X,Y=Y,V=V,yaml_file='example.yaml')
+#'
+#' @export causalegm
+causalegm <- function(X, Y, V,
+                        output_dir = "./",
+                        dataset = "myData",
+                        z_dims = c(3,3,6,6),
+                        lr = 0.0002,
+                        alpha =1,
+                        beta = 1,
+                        gamma = 10,
+                        g_d_freq = 5,
+                        g_units = c(64,64,64,64,64),
+                        e_units = c(64,64,64,64,64),
+                        f_units = c(64,32,8),
+                        h_units = c(64,32,8),
+                        dv_units = c(64,32,8),
+                        dz_units = c(64,32,8),
+                        save_model = FALSE,
+                        binary_treatment = TRUE,
+                        use_z_rec = TRUE,
+                        use_v_gan = TRUE,
+                        random_seed = 123,
+                        n_iter = 20000) {
+
+  #To ignore the warnings during usage
+  options(warn=-1)
+  options("getSymbols.warning4.0"=FALSE)
+  if (!(py_module_available('CausalEGM'))){
+    py_install("CausalEGM", method="auto",pip=TRUE)
+  }
+  #get number of covariates
+  v_dim <- dim(V)[2]
+  params <- list(output_dir = output_dir,
+                 dataset = dataset,
+                 z_dims = as.integer(z_dims),
+                 v_dim = v_dim,
+                 lr = lr,
+                 alpha = alpha,
+                 beta = beta,
+                 gamma = gamma,
+                 g_d_freq = as.integer(g_d_freq),
+                 g_units = g_units,
+                 e_units = e_units,
+                 f_units = f_units,
+                 h_units = h_units,
+                 dv_units = dv_units,
+                 dz_units = dz_units,
+                 save_model = save_model,
+                 binary_treatment = binary_treatment,
+                 use_z_rec = use_z_rec,
+                 use_v_gan = use_v_gan)
+
+  cegm <- import("CausalEGM")
+  model <- cegm$CausalEGM(params=params,random_seed=as.integer(random_seed))
+  data <- list(X,Y,V)
+  model$train(data,n_iter = as.integer(n_iter))
+  model
+}

r-package/RcausalEGM/RcausalEGM.Rproj

@@ -0,0 +1,22 @@
+Version: 1.0
+
+RestoreWorkspace: Default
+SaveWorkspace: Default
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: knitr
+LaTeX: pdfLaTeX
+
+AutoAppendNewline: Yes
+StripTrailingWhitespace: Yes
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source
+PackageCheckArgs: --as-cran
+PackageRoxygenize: rd,collate,namespace

r-package/RcausalEGM/man/hello.Rd

@@ -0,0 +1,12 @@
+\name{hello}
+\alias{hello}
+\title{Hello, World!}
+\usage{
+hello()
+}
+\description{
+Prints 'Hello, world!'.
+}
+\examples{
+hello()
+}