Skeleton

coatless · coatless · commit 26bab8204414 · 2025-03-24T03:22:00.000-07:00
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -0,0 +1,6 @@
+^.*\.Rproj$
+^\.Rproj\.user$
+^\.devcontainer$
+^\.github$
+^LICENSE\.md$
+^README\.Rmd$
diff --git a/.github/.devcontainer/devcontainer.json b/.github/.devcontainer/devcontainer.json
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+.Rproj.user
+.Rhistory
+.RData
+.Ruserdata
+.DS_Store
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -0,0 +1,26 @@
+Package: shinydocker
+Title: Containerize Shiny Applications with Docker
+Version: 0.1.0
+Authors@R: c(
+    person("James Joseph", "Balamuta",
+            email = "james.balamuta@gmail.com", 
+            role = c("aut", "cre"),
+            comment = c(ORCID = "0000-0003-2826-8458")
+           )
+    )
+Description: Provides tools to export Shiny applications (R or Python) into
+    Docker containers. This package generates appropriate Docker configuration,
+    builds the container, and provides utilities to run the containerized application.
+License: MIT + file LICENSE
+Encoding: UTF-8
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.3.2
+Imports: 
+    yaml,
+    processx,
+    fs,
+    glue,
+    cli
+Suggests:
+    testthat (>= 3.0.0)
+Config/testthat/edition: 3
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,2 @@
+YEAR: 2025
+COPYRIGHT HOLDER: shinydocker authors
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2025 shinydocker authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.Rmd b/README.Rmd
@@ -0,0 +1,55 @@
+---
+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%"
+)
+```
+
+# shinydocker
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+The goal of shinydocker is to ...
+
+## Installation
+
+You can install the development version of shinydocker from [GitHub](https://github.com/) with:
+
+``` r
+# install.packages("pak")
+pak::pak("coatless-rpkg/shinydocker")
+```
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+```{r example}
+library(shinydocker)
+## basic example code
+```
+
+What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:
+
+```{r cars}
+summary(cars)
+```
+
+You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this.
+
+You can also embed plots, for example:
+
+```{r pressure, echo = FALSE}
+plot(pressure)
+```
+
+In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.
diff --git a/README.md b/README.md
@@ -1,60 +1,53 @@
-# r-pkg
 
-This repository houses a devcontainer that setups an R package development environment. The container is setup to work with [GitHub Codespaces](https://github.com/features/codespaces) to instantly have a cloud-based developer workflow.
+<!-- README.md is generated from README.Rmd. Please edit that file -->
 
-You can try out the Codespace by clicking on the following button:
+# shinydocker
 
-[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/coatless-devcontainer/r-pkg?quickstart=1)
+<!-- badges: start -->
 
-> [!NOTE]
->
-> Codespaces are available to Students and Teachers for free [up to 180 core hours per month](https://docs.github.com/en/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom#about-github-codespaces)
-> through [GitHub Education](https://education.github.com/). Otherwise, you will have 
-> [up to 60 core hours and 15 GB free per month](https://github.com/features/codespaces#pricing).
+<!-- badges: end -->
 
-Or, you can press the template button to create a new repository with the same setup so that you
-can work locally on the devcontainer:
+The goal of shinydocker is to …
 
-[![Use this template](https://img.shields.io/badge/Use%20this%20template-Create%20new%20repository-blue?logo=github)](https://github.com/coatless-devcontainer/r-pkg/generate)
+## Installation
 
-This will create a fork of the repository that can be worked on inside a local copy of
-[Visual Studio Code](https://code.visualstudio.com/) through the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). With the extension installed, you can open the repository in a container by pressing `F1` (to bring up command palette) and typing `Dev Container: Reopen in Container`.
+You can install the development version of shinydocker from
+[GitHub](https://github.com/) with:
 
-Lastly, you can directly obtain the underlying container image by typing in Terminal: 
-
-```sh
-docker pull ghcr.io/coatless-devcontainer/r-pkg:latest
+``` r
+# install.packages("pak")
+pak::pak("coatless-rpkg/shinydocker")
 ```
 
-## Quick start
+## Example
 
-Run the following series of commands inside of R once the container opens. Make sure to change `"name-of-package"` to your current package name.
+This is a basic example which shows you how to solve a common problem:
 
-```r
-usethis::create_package("name-of-package")
-usethis::use_package_doc()
-usethis::use_agpl3_license()
-usethis::use_testthat()
-usethis::use_github_action("check-standard")
-usethis::use_pkgdown_github_pages()
+``` r
+library(shinydocker)
+## basic example code
 ```
 
-## Resources
-
-- [Manual: Writing R extensions](https://cran.r-project.org/doc/manuals/r-release/R-exts.html)
-- [Textbook: R Packages](https://r-pkgs.org/)
-- [usethis](https://usethis.r-lib.org/)
-- [devtools](https://devtools.r-lib.org/)
+What is special about using `README.Rmd` instead of just `README.md`?
+You can include R chunks like so:
+
+``` r
+summary(cars)
+#>      speed           dist       
+#>  Min.   : 4.0   Min.   :  2.00  
+#>  1st Qu.:12.0   1st Qu.: 26.00  
+#>  Median :15.0   Median : 36.00  
+#>  Mean   :15.4   Mean   : 42.98  
+#>  3rd Qu.:19.0   3rd Qu.: 56.00  
+#>  Max.   :25.0   Max.   :120.00
+```
 
-## Developer notes
+You’ll still need to render `README.Rmd` regularly, to keep `README.md`
+up-to-date. `devtools::build_readme()` is handy for this.
 
-This repository uses a pre-built container strategy to have GitHub Actions build and, then, store the devcontainer in [GitHub's Container Repository](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry). 
+You can also embed plots, for example:
 
-We place the main logic of the devcontainer in [`.github/.devcontainer/devcontainer.json`](https://github.com/coatless-devcontainer/r-pkg/blob/main/.github/.devcontainer/devcontainer.json). From there, we use [`.github/workflows/pre-build-devcontainer.yml`](https://github.com/coatless-devcontainer/r-pkg/blob/main/.github/workflows/pre-build-devcontainer.yml) to build and publish the devcontainer onto GitHub's Container repository for the organization. Then, the repository's [`.devcontainer/devcontainer.json`](https://github.com/coatless-devcontainer/r-pkg/blob/main/.devcontainer/devcontainer.json) pulls the pre-built image.
+<img src="man/figures/README-pressure-1.png" width="100%" />
 
-> [!IMPORTANT]
->
-> Make sure to specify the permissions as stated in the GitHub Actions workflow linked above
-> and for organizations please make sure to have the organization's container registry enabled.
-> 
-> For more information, see [GitHub's Container Registry documentation](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry).
+In that case, don’t forget to commit and push the resulting figure
+files, so they display on GitHub and CRAN.
diff --git a/shinydocker.Rproj b/shinydocker.Rproj
@@ -0,0 +1,19 @@
+Version: 1.0
+ProjectId: ae08b067-0a62-43fc-a628-454dcf14140f
+
+RestoreWorkspace: Default
+SaveWorkspace: Default
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+YEAR: 2025`
	`2`	`+COPYRIGHT HOLDER: shinydocker authors`