Merge pull request #1 from markean/dev

package metadata and structure updated

.Rbuildignore

@@ -2,3 +2,8 @@
 ^renv\.lock$
 ^.*\.Rproj$
 ^\.Rproj\.user$
+^LICENSE\.md$
+^README\.Rmd$
+^data-raw$
+^\.github$
+^codemeta\.json$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/R-CMD-check.yaml

@@ -0,0 +1,49 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+name: R-CMD-check
+
+jobs:
+  R-CMD-check:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: macos-latest,   r: 'release'}
+          - {os: windows-latest, r: 'release'}
+          - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
+          - {os: ubuntu-latest,   r: 'release'}
+          - {os: ubuntu-latest,   r: 'oldrel-1'}
+
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::rcmdcheck
+          needs: check
+
+      - uses: r-lib/actions/check-r-package@v2
+        with:
+          upload-snapshots: true

DESCRIPTION

@@ -1,11 +1,26 @@
 Package: retel
 Type: Package
-Title: What the Package Does (Title Case)
-Version: 0.1.0
-Author: Who wrote it
-Maintainer: The package maintainer <yourself@somewhere.net>
-Description: More about what it does (maybe more than one line)
-    Use four spaces when indenting paragraphs within the Description.
-License: What license is it under?
+Title: Regularized Exponentially Tilted Empirical Likelihood
+Version: 0.1.0.9000
+Authors@R: c(
+    person("Eunseop", "Kim", email = "markean@pm.me", 
+            role = c("aut", "cre")),
+    person("Steven", "MacEachern", role = c("ctb", "ths")),
+    person("Mario", "Peruggia", role = c("ctb", "ths"))
+  )
+Description: Computes regularized exponentially tilted empirical likelihood for
+    Bayesian inference. Details of the methods are given in Kim, MacEachern, and
+    Peruggia (2023) <doi:10.48550/arXiv.2112.09206>. This work was supported 
+    by the U.S. National Science Foundation under Grants No. SES-1921523 and 
+    DMS-2015552.
+License: GPL (>= 3)
+URL: https://github.com/markean/retel
+BugReports: https://github.com/markean/retel/issues
+Depends: 
+    R (>= 4.1.0)
+Suggests: 
+    melt,
+    spelling
 Encoding: UTF-8
+Language: en-US
 LazyData: true

NEWS.md

@@ -0,0 +1,5 @@
+# retel (development version)
+
+
+# retel 0.1.0
+* Initial release.

README.Rmd

@@ -0,0 +1,35 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+```
+
+# retel
+<!-- badges: start -->
+[![Project Status: Concept – Minimal or no implementation has been done yet, or the repository is only intended to be a limited example, demo, or proof-of-concept.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)
+[![R-CMD-check](https://github.com/markean/retel/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/markean/retel/actions/workflows/R-CMD-check.yaml)
+<!-- badges: end -->
+
+## Overview
+Computes regularized exponentially tilted empirical likelihood for Bayesian inference.
+
+This repository accompanies the research paper titled 'Regularized Exponentially Tilted Empirical Likelihood for Bayesian Inference,' available on [arXiv](https://arxiv.org/abs/2112.09206).
+The `retel-paper` folder contains code and additional resources related to the paper.
+This work was supported by the U.S. National Science Foundation under Grants No. [SES-1921523](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1921523) and [DMS-2015552](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2015552).
+
+
+## Installation
+You can install the development version of retel from [GitHub](https://github.com/) with:
+``` r
+# install.packages("devtools")
+devtools::install_github("markean/retel")
+```

README.md

@@ -1 +1,38 @@
-# retel - Regularized Exponentially Tilted Empirical Likelihood
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+# retel
+
+<!-- badges: start -->
+
+[![Project Status: Concept – Minimal or no implementation has been done
+yet, or the repository is only intended to be a limited example, demo,
+or
+proof-of-concept.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)
+[![R-CMD-check](https://github.com/markean/retel/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/markean/retel/actions/workflows/R-CMD-check.yaml)
+<!-- badges: end -->
+
+## Overview
+
+Computes regularized exponentially tilted empirical likelihood for
+Bayesian inference.
+
+This repository accompanies the research paper titled ‘Regularized
+Exponentially Tilted Empirical Likelihood for Bayesian Inference,’
+available on [arXiv](https://arxiv.org/abs/2112.09206). The
+`retel-paper` folder contains code and additional resources related to
+the paper. This work was supported by the U.S. National Science
+Foundation under Grants
+No. [SES-1921523](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1921523)
+and
+[DMS-2015552](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2015552).
+
+## Installation
+
+You can install the development version of retel from
+[GitHub](https://github.com/) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("markean/retel")
+```

codemeta.json

@@ -0,0 +1,95 @@
+{
+  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
+  "@type": "SoftwareSourceCode",
+  "identifier": "retel",
+  "description": "Computes regularized exponentially tilted empirical likelihood for Bayesian inference. Details of the methods are given in Kim, MacEachern, and Peruggia (2023) <doi:10.48550/arXiv.2112.09206>. This work was supported by the U.S. National Science Foundation under Grants No. SES-1921523 and DMS-2015552.",
+  "name": "retel: Regularized Exponentially Tilted Empirical Likelihood",
+  "codeRepository": "https://github.com/markean/retel",
+  "issueTracker": "https://github.com/markean/retel/issues",
+  "license": "https://spdx.org/licenses/GPL-3.0",
+  "version": "0.1.0.9000",
+  "programmingLanguage": {
+    "@type": "ComputerLanguage",
+    "name": "R",
+    "url": "https://r-project.org"
+  },
+  "runtimePlatform": "R version 4.3.2 (2023-10-31)",
+  "author": [
+    {
+      "@type": "Person",
+      "givenName": "Eunseop",
+      "familyName": "Kim",
+      "email": "markean@pm.me"
+    }
+  ],
+  "contributor": [
+    {
+      "@type": "Person",
+      "givenName": "Steven",
+      "familyName": "MacEachern"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Mario",
+      "familyName": "Peruggia"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Steven",
+      "familyName": "MacEachern"
+    },
+    {
+      "@type": "Person",
+      "givenName": "Mario",
+      "familyName": "Peruggia"
+    }
+  ],
+  "maintainer": [
+    {
+      "@type": "Person",
+      "givenName": "Eunseop",
+      "familyName": "Kim",
+      "email": "markean@pm.me"
+    }
+  ],
+  "softwareSuggestions": [
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "melt",
+      "name": "melt",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Comprehensive R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      },
+      "sameAs": "https://CRAN.R-project.org/package=melt"
+    },
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "spelling",
+      "name": "spelling",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Comprehensive R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      },
+      "sameAs": "https://CRAN.R-project.org/package=spelling"
+    }
+  ],
+  "softwareRequirements": {
+    "1": {
+      "@type": "SoftwareApplication",
+      "identifier": "R",
+      "name": "R",
+      "version": ">= 4.1.0"
+    },
+    "SystemRequirements": null
+  },
+  "fileSize": "2481.81KB",
+  "readme": "https://github.com/markean/retel/blob/main/README.md",
+  "contIntegration": "https://github.com/markean/retel/actions/workflows/R-CMD-check.yaml",
+  "developmentStatus": "https://www.repostatus.org/#concept",
+  "keywords": ["r", "r-package", "rstats"]
+}

data-raw/DATASET.R

@@ -0,0 +1,3 @@
+## code to prepare `DATASET` dataset goes here
+
+usethis::use_data(DATASET, overwrite = TRUE)

inst/WORDLIST

@@ -0,0 +1,2 @@
+arXiv
+’

tests/spelling.R

@@ -0,0 +1,3 @@
+if(requireNamespace('spelling', quietly = TRUE))
+  spelling::spell_check_test(vignettes = TRUE, error = FALSE,
+                             skip_on_cran = TRUE)