Skip to content

Commit

Permalink
directory structure test
Browse files Browse the repository at this point in the history
  • Loading branch information
eunseopkim committed Jan 22, 2024
1 parent c37e66e commit 1c2d234
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 20 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
Package: retel
Type: Package
Title: Regularized Exponentially Tilted Empirical Likelihood
Version: 0.1.0.9000
Version: 0.1.0.9001
Authors@R: c(
person("Eunseop", "Kim", email = "markean@pm.me",
role = c("aut", "cph", "cre")),
person("Steven", "MacEachern", role = c("ctb", "ths")),
person("Mario", "Peruggia", role = c("ctb", "ths"))
)
Description: Implements the regularized exponentially tilted empirical
likelihood method. Details of the methods are given in Kim, MacEachern, and
likelihood method. Details of the method are given in Kim, MacEachern, and
Peruggia (2023) <doi:10.48550/arXiv.2312.17015>. This work was supported by
the U.S. National Science Foundation under Grants No. SES-1921523 and
DMS-2015552.
Expand Down
2 changes: 1 addition & 1 deletion man/retel-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 0 additions & 3 deletions retel-paper/.Rbuildignore

This file was deleted.

20 changes: 14 additions & 6 deletions retel-paper/README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,20 @@ You can install the development version of retel from [GitHub](https://github.co
# 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.

## Example
## 🗂️ Directory Structure

This is a basic example which shows you how to solve a common problem:

```{r example}
#library(retel)
## basic example code
```
.
├── application/ <- 📂 Application outputs
├── code/ <- 📂 All code for reproducibility
├── figures/ <- 📂 Figure files (PDFs and PNGs)
├── renv/ <- 📂 R environment and package dependency management
├── simulations/ <- 📂 Simulation outputs
├── .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
```
24 changes: 16 additions & 8 deletions retel-paper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,19 @@ You can install the development version of retel from
devtools::install_github("markean/retel")
```

## Example

This is a basic example which shows you how to solve a common problem:

``` r
#library(retel)
## basic example code
```
The following sections provide an overview of the directory structure
and instructions for setting up your project workspace.

## 🗂️ Directory Structure

.
├── application/ <- 📂 Application outputs
├── code/ <- 📂 All code for reproducibility
├── figures/ <- 📂 Figure files (PDFs and PNGs)
├── renv/ <- 📂 R environment and package dependency management
├── simulations/ <- 📂 Simulation outputs
├── .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

0 comments on commit 1c2d234

Please sign in to comment.