directory structure added

markean · Jan 23, 2024 · 38c1f77 · 38c1f77
1 parent 1c2d234
commit 38c1f77
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 37 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: retel
 Type: Package
 Title: Regularized Exponentially Tilted Empirical Likelihood
-Version: 0.1.0.9001
+Version: 0.1.0.9002
 Authors@R: c(
     person("Eunseop", "Kim", email = "markean@pm.me", 
             role = c("aut", "cph", "cre")),

diff --git a/retel-paper/README.Rmd b/retel-paper/README.Rmd
@@ -13,35 +13,52 @@ knitr::opts_chunk$set(
 )
 ```
 
-# retel
+# retel-paper
 
-<!-- badges: start -->
-<!-- badges: end -->
+Reproducible code for generating figures and outputs from simulations and the application presented in the paper 'Regularized Exponentially Tilted Empirical Likelihood for Bayesian Inference,' accessible on [arXiv](https://arxiv.org/abs/2312.17015).
+The following sections outline the directory structure and provide detailed instructions for replicating the results.
 
-The goal of retel is to ...
-
-## Installation
-
-You can install the development version of retel from [GitHub](https://github.com/) with:
-
-``` r
-# install.packages("devtools")
-devtools::install_github("markean/retel")
-```
-The following sections provide an overview of the directory structure and instructions for setting up your project workspace.
-
-## 🗂️ Directory Structure
+## Directory Structure
 
 ```
 .
 ├── application/        <- 📂 Application outputs
 ├── code/               <- 📂 All code for reproducibility
+│   ├── application/        <- 📂 Code for application in Section 5
+│   ├── figures/            <- 📂 Code for figures 
+│   │   ├── supplement/         <- 📂 Supplement figures  
+│   ├── simulations/        <- 📂 Code for simulations
+│   │   ├── cr/                 <- 📂 Simulations in Section 4.1
+│   │   │   ├── l0/                 <- 📂 Table 2 when l = 0
+│   │   │   ├── l2/                 <- 📂 Table 3 when l = 2
+│   │   ├── kl/                 <- 📂 Simulations in Section 4.2
+│   │   │   ├── el/                 <- 📂 EL implementation
+│   │   │   ├── etel/               <- 📂 ETEL implementation
+│   │   │   ├── retel_f/            <- 📂 RETEL_f implementation
+│   │   │   ├── retel_r/            <- 📂 RETEL_r implementation
+│   │   ├── mb/                 <- 📂 Simulations in Section 4.1
+│   │   │   ├── tau1/               <- 📂 Table 1 when tau_n = 1
+│   │   │   ├── taulogn/            <- 📂 Table 1 when tau_n = log(n)
 ├── figures/            <- 📂 Figure files (PDFs and PNGs)
+│   ├── supplement/         <- 📂 Supplement figures 
 ├── renv/               <- 📂 R environment and package dependency management
 ├── simulations/        <- 📂 Simulation outputs
+│   ├── cr/                 <- 📂 Outputs in Section 4.1
+│   │   ├── l0/                 <- 📂 Table 2 when l = 0
+│   │   ├── l2/                 <- 📂 Table 3 when l = 2
+│   ├── kl/                 <- 📂 Outputs in Section 4.2
+│   │   ├── el/                 <- 📂 EL outputs
+│   │   ├── etel/               <- 📂 ETEL outputs
+│   │   ├── retel_f/            <- 📂 RETEL_f outputs
+│   │   ├── retel_r/            <- 📂 RETEL_r outputs
+│   ├── mb/                 <- 📂 Outputs in Section 4.1
+│   │   ├── tau1/               <- 📂 Table 1 when tau_n = 1
+│   │   ├── taulogn/            <- 📂 Table 1 when tau_n = log(n)
 ├── .Rprofile           <- 🔧 Configuration file for R environment, including settings for renv
 ├── README.Rmd          <- 📝 README file written in R Markdown format
 ├── README.md           <- 📝 README file generated from README.Rmd
 ├── renv.lock           <- 📦 Lock file to set up the environment
 ├── retel-paper.Rproj   <- 🖥️ R Project file for RStudio 
-```
+```
+
+## Instructions for Reproducibility
diff --git a/retel-paper/README.md b/retel-paper/README.md
@@ -1,36 +1,54 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# retel
+# retel-paper
 
-<!-- badges: start -->
-<!-- badges: end -->
+Reproducible code for generating figures and outputs from simulations
+and the application presented in the paper ‘Regularized Exponentially
+Tilted Empirical Likelihood for Bayesian Inference,’ accessible on
+[arXiv](https://arxiv.org/abs/2312.17015). The following sections
+outline the directory structure and provide detailed instructions for
+replicating the results.
 
-The goal of retel is to …
-
-## Installation
-
-You can install the development version of retel from
-[GitHub](https://github.com/) with:
-
-``` r
-# install.packages("devtools")
-devtools::install_github("markean/retel")
-```
-
-The following sections provide an overview of the directory structure
-and instructions for setting up your project workspace.
-
-## 🗂️ Directory Structure
+## Directory Structure
 
     .
     ├── application/        <- 📂 Application outputs
     ├── code/               <- 📂 All code for reproducibility
+    │   ├── application/        <- 📂 Code for application in Section 5
+    │   ├── figures/            <- 📂 Code for figures 
+    │   │   ├── supplement/         <- 📂 Supplement figures  
+    │   ├── simulations/        <- 📂 Code for simulations
+    │   │   ├── cr/                 <- 📂 Simulations in Section 4.1
+    │   │   │   ├── l0/                 <- 📂 Table 2 when l = 0
+    │   │   │   ├── l2/                 <- 📂 Table 3 when l = 2
+    │   │   ├── kl/                 <- 📂 Simulations in Section 4.2
+    │   │   │   ├── el/                 <- 📂 EL implementation
+    │   │   │   ├── etel/               <- 📂 ETEL implementation
+    │   │   │   ├── retel_f/            <- 📂 RETEL_f implementation
+    │   │   │   ├── retel_r/            <- 📂 RETEL_r implementation
+    │   │   ├── mb/                 <- 📂 Simulations in Section 4.1
+    │   │   │   ├── tau1/               <- 📂 Table 1 when tau_n = 1
+    │   │   │   ├── taulogn/            <- 📂 Table 1 when tau_n = log(n)
     ├── figures/            <- 📂 Figure files (PDFs and PNGs)
+    │   ├── supplement/         <- 📂 Supplement figures 
     ├── renv/               <- 📂 R environment and package dependency management
     ├── simulations/        <- 📂 Simulation outputs
+    │   ├── cr/                 <- 📂 Outputs in Section 4.1
+    │   │   ├── l0/                 <- 📂 Table 2 when l = 0
+    │   │   ├── l2/                 <- 📂 Table 3 when l = 2
+    │   ├── kl/                 <- 📂 Outputs in Section 4.2
+    │   │   ├── el/                 <- 📂 EL outputs
+    │   │   ├── etel/               <- 📂 ETEL outputs
+    │   │   ├── retel_f/            <- 📂 RETEL_f outputs
+    │   │   ├── retel_r/            <- 📂 RETEL_r outputs
+    │   ├── mb/                 <- 📂 Outputs in Section 4.1
+    │   │   ├── tau1/               <- 📂 Table 1 when tau_n = 1
+    │   │   ├── taulogn/            <- 📂 Table 1 when tau_n = log(n)
     ├── .Rprofile           <- 🔧 Configuration file for R environment, including settings for renv
     ├── README.Rmd          <- 📝 README file written in R Markdown format
     ├── README.md           <- 📝 README file generated from README.Rmd
     ├── renv.lock           <- 📦 Lock file to set up the environment
     ├── retel-paper.Rproj   <- 🖥️ R Project file for RStudio 
+
+## Instructions for Reproducibility