diff --git a/404.html b/404.html index 4a2f9ee..d42d811 100644 --- a/404.html +++ b/404.html @@ -40,17 +40,6 @@
  • Reference
  • Changelog
    • -
  • -
    develop -main -reference -articles -news -deps
    • - @@ -58,7 +47,8 @@

    Bug Fixes

    Configuration

    - diff --git a/LICENSE-text.html b/LICENSE-text.html index 27af8c3..24bfeee 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -19,17 +19,6 @@
  • Reference
  • Changelog
    • diff --git a/LICENSE.html b/LICENSE.html index 3d18466..b1ec0af 100644 --- a/LICENSE.html +++ b/LICENSE.html @@ -19,17 +19,6 @@
  • Reference
  • Changelog
    • diff --git a/articles/index.html b/articles/index.html index 681439f..2e13f71 100644 --- a/articles/index.html +++ b/articles/index.html @@ -19,17 +19,6 @@
  • Reference
  • Changelog
    • diff --git a/articles/rshinycloudrun.html b/articles/rshinycloudrun.html index 3f50a6a..42c30e3 100644 --- a/articles/rshinycloudrun.html +++ b/articles/rshinycloudrun.html @@ -39,17 +39,6 @@
  • Reference
  • Changelog
    • -
  • -
    develop -main -reference -articles -news -deps
    • - diff --git a/index.html b/index.html index 840526b..b0e70fb 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,221 @@ + + + -demo-rshiny-cloudrun - - + + +Shiny App on Google Cloud Run • rshinycloudrun + + + + + + + + + + + + + + + + + Skip to contents + + +
    +
    +
    +

    +R Shiny App on GCP Cloud Run Demo +

    +
    +

    +Changelog · Documentation · Docker Containers +

    +

    +R ShinyGoogle Cloud Run

    +

    +Typing SVG

    +
    +
    +

    Note: This is an R package built by No Clocks, LLC for demonstration purposes. It aims to showcase how to develop and deploy an R Shiny app as a package to Google Cloud Platform’s (GCP) Cloud Run service using Docker.

    +
    +
    +
    +

    Contents +

    + +
    +
    +

    Badges +

    + + +
    +
    +

    Overview +

    +

    This repository contains an R package that demonstrates how to build and deploy an R Shiny app to Google Cloud Platform’s (GCP) Cloud Run service using Docker.

    +
    +
    +

    Installation +

    +

    You can install the development version of rshinycloudrun from GitHub with your preferred installation method below:

    +
    +

    Notice that although the R package is named rshinycloudrun, the GitHub repository is named demo-rshiny-cloudrun. This is for internal organization purposes and should not affect the installation process.

    +
    +
    +# Install using remotes
+remotes::install_github("noclocks/demo-rshiny-cloudrun")
+
+# Or using devtools
+devtools::install_github("noclocks/demo-rshiny-cloudrun")
+
+# Or using pak
+pak::pkg_install("noclocks/demo-rshiny-cloudrun")
    +
    +
    +

    Usage +

    +

    Once installed, you can load the package and run the Shiny app using the following commands:

    + +
    +
    +

    Deployment +

    +

    The package is set up to build and deploy the R Shiny app to Google Cloud Platform’s (GCP) Cloud Run service using Docker.

    +
    +

    Pre-Requisites +

    +
      +
    1. Google Cloud Platform (GCP) Account
      2. +
    2. Docker Desktop
      3. +
    3. R
      4. +
    4. RStudio
      5. +
    5. R Shiny
      6. +
    6. Google Cloud SDK
      7. +
    7. Google Cloud Run
      8. +
    +
    +
    +
    +

    Code of Conduct +

    +

    Please note that the rshinycloudrun package is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

    +
    +

    © 2024 No Clocks, LLC

    +
    + +
    +
    + + +
    +

    Developed by Jimmy Briggs, Patrick Howard, No Clocks, LLC.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    +
    + + + + + + + diff --git a/news/index.html b/news/index.html index d00de0b..0b7ac88 100644 --- a/news/index.html +++ b/news/index.html @@ -19,17 +19,6 @@
  • Reference
  • Changelog
    • diff --git a/pkgdown.yml b/pkgdown.yml index 2cc7fbc..66a6b20 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -1,9 +1,9 @@ -pandoc: '3.2' +pandoc: 3.1.11 pkgdown: 2.1.0 pkgdown_sha: ~ articles: rshinycloudrun: rshinycloudrun.html -last_built: 2024-09-11T18:32Z +last_built: 2024-09-11T18:35Z urls: - reference: https://docs.noclocks.dev/demo-rshiny-cloudrun/main/reference - article: https://docs.noclocks.dev/demo-rshiny-cloudrun/main/articles + reference: https://docs.noclocks.dev/demo-rshiny-cloudrun/reference + article: https://docs.noclocks.dev/demo-rshiny-cloudrun/articles diff --git a/reference/app_sys.html b/reference/app_sys.html index adde947..48713c2 100644 --- a/reference/app_sys.html +++ b/reference/app_sys.html @@ -19,17 +19,6 @@
  • Reference
  • Changelog
    • diff --git a/reference/get_app_config.html b/reference/get_app_config.html index 9348a9a..a6c26d4 100644 --- a/reference/get_app_config.html +++ b/reference/get_app_config.html @@ -19,17 +19,6 @@
  • Reference
  • Changelog
    • diff --git a/reference/index.html b/reference/index.html index 28d5fa7..fe2e57e 100644 --- a/reference/index.html +++ b/reference/index.html @@ -19,17 +19,6 @@
  • Reference
  • Changelog
    • diff --git a/reference/rshinycloudrun-package.html b/reference/rshinycloudrun-package.html index 430c80b..5e392ba 100644 --- a/reference/rshinycloudrun-package.html +++ b/reference/rshinycloudrun-package.html @@ -21,17 +21,6 @@
  • Reference
  • Changelog
    • diff --git a/reference/run_app.html b/reference/run_app.html index 34248e5..5c8bbc7 100644 --- a/reference/run_app.html +++ b/reference/run_app.html @@ -19,17 +19,6 @@
  • Reference
  • Changelog
    • diff --git a/search.json b/search.json index e52cda5..334e12b 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CHANGELOG.html","id":null,"dir":"","previous_headings":"","what":"Changelog","title":"Changelog","text":"notable changes project documented file. format based Keep Changelog project adheres Semantic Versioning.","code":""},{"path":[]},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CHANGELOG.html","id":"bug-fixes","dir":"","previous_headings":"","what":"Bug Fixes","title":"Changelog","text":"Fix GHA (cb752bd) - (Jimmy Briggs) Fix GHA (0f67c58) - (Jimmy Briggs)","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CHANGELOG.html","id":"configuration","dir":"","previous_headings":"","what":"Configuration","title":"Changelog","text":"Buildignore index.md (2de3533) - (Jimmy Briggs)","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CHANGELOG.html","id":"documentation","dir":"","previous_headings":"","what":"Documentation","title":"Changelog","text":"Separate index.md README.md pkgdown (82ffd12) - (Jimmy Briggs) Add TOC (cf26d28) - (Jimmy Briggs) Add images (4837232) - (Jimmy Briggs) Update README (1988447) - (Jimmy Briggs)","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CHANGELOG.html","id":"features","dir":"","previous_headings":"","what":"Features","title":"Changelog","text":"Bulk update (f42c20a) - (Jimmy Briggs) Update DESCRIPTION (170a352) - (Jimmy Briggs) Add pkgdown (311e384) - (Jimmy Briggs) Add GHA GHCR (docker-ghcr.yml) (57fa3ed) - (Jimmy Briggs) Add terraform infra code docker build GHA (eaacdfd) - (Jimmy Briggs) Add deployment docker (e4d9078) - (Jimmy Briggs) Changelog generated git-cliff. ***","code":""},{"path":[]},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement Clocks, LLC. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 Clocks, LLC Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Jimmy Briggs. Author, maintainer. Patrick Howard. Author, reviewer. Clocks, LLC. Copyright holder, funder.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Briggs J, Howard P (2024). rshinycloudrun: Shiny App Google Cloud Run. R package version 0.0.1, https://docs.noclocks.dev/demo-rshiny-cloudrun/, https://github.com/noclocks/demo-rshiny-cloudrun.","code":"@Manual{, title = {rshinycloudrun: Shiny App on Google Cloud Run}, author = {Jimmy Briggs and Patrick Howard}, year = {2024}, note = {R package version 0.0.1, https://docs.noclocks.dev/demo-rshiny-cloudrun/}, url = {https://github.com/noclocks/demo-rshiny-cloudrun}, }"},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/index.html","id":"contents","dir":"","previous_headings":"","what":"Contents","title":"Shiny App on Google Cloud Run","text":"Badges Overview Installation Usage Pre-Requisites Code Conduct","code":""},{"path":[]},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/index.html","id":"overview","dir":"","previous_headings":"","what":"Overview","title":"Shiny App on Google Cloud Run","text":"repository contains R package demonstrates build deploy R Shiny app Google Cloud Platform’s (GCP) Cloud Run service using Docker.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Shiny App on Google Cloud Run","text":"can install development version rshinycloudrun GitHub preferred installation method : Notice although R package named rshinycloudrun, GitHub repository named demo-rshiny-cloudrun. internal organization purposes affect installation process.","code":"# Install using remotes remotes::install_github(\"noclocks/demo-rshiny-cloudrun\") # Or using devtools devtools::install_github(\"noclocks/demo-rshiny-cloudrun\") # Or using pak pak::pkg_install(\"noclocks/demo-rshiny-cloudrun\")"},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Shiny App on Google Cloud Run","text":"installed, can load package run Shiny app using following commands:","code":"library(rshinycloudrun) run_app()"},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/index.html","id":"deployment","dir":"","previous_headings":"","what":"Deployment","title":"Shiny App on Google Cloud Run","text":"package set build deploy R Shiny app Google Cloud Platform’s (GCP) Cloud Run service using Docker.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/index.html","id":"pre-requisites","dir":"","previous_headings":"Deployment","what":"Pre-Requisites","title":"Shiny App on Google Cloud Run","text":"Google Cloud Platform (GCP) Account Docker Desktop R RStudio R Shiny Google Cloud SDK Google Cloud Run","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/index.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Shiny App on Google Cloud Run","text":"Please note rshinycloudrun package released Contributor Code Conduct. contributing project, agree abide terms. © 2024 Clocks, LLC","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/app_sys.html","id":null,"dir":"Reference","previous_headings":"","what":"App Sys — app_sys","title":"App Sys — app_sys","text":"Access files current app.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/app_sys.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"App Sys — app_sys","text":"","code":"app_sys(...)"},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/app_sys.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"App Sys — app_sys","text":"... (Optional) Character Vector(s) specifying paths file(s) within R package's installation folder. Defaults nothing returns root app package folder.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/app_sys.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"App Sys — app_sys","text":"Character vector positive length, containing file paths matched `...`, empty string, `\"\"`, none matched.","code":""},{"path":[]},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/app_sys.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"App Sys — app_sys","text":"","code":"config_file <- app_sys(\"config/config.yml\") #> Error in app_sys(\"config/config.yml\"): could not find function \"app_sys\""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/get_app_config.html","id":null,"dir":"Reference","previous_headings":"","what":"Get App Config — get_app_config","title":"Get App Config — get_app_config","text":"Retrieves value app package's configuration file, `config.yml`.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/get_app_config.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get App Config — get_app_config","text":"","code":"get_app_config( value, config = Sys.getenv(\"APP_CONFIG_ACTIVE\", Sys.getenv(\"R_CONFIG_ACTIVE\", \"default\")), use_parent = TRUE, file = app_sys(\"config.yml\") )"},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/get_app_config.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get App Config — get_app_config","text":"value (Required) Value retrieve config file. config (Optional) Configuration environment use. Defaults `APP_CONFIG_ACTIVE`'s environment variable, available, , uses `R_CONFIG_ACTIVE`'s environment variable. Finally still unset, defaults `default`. use_parent (Optional) Logical, scan parent directory config file. Defaults `TRUE`. file (Optional) Character path location config file. Defaults `config.yml` file app package's root installation directory via `app_sys(\"config.yml\")`.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/get_app_config.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get App Config — get_app_config","text":"value config file.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/rshinycloudrun-package.html","id":null,"dir":"Reference","previous_headings":"","what":"rshinycloudrun: Shiny App on Google Cloud Run — rshinycloudrun-package","title":"rshinycloudrun: Shiny App on Google Cloud Run — rshinycloudrun-package","text":"Deploy Shiny app Google Cloud Run.","code":""},{"path":[]},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/rshinycloudrun-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"rshinycloudrun: Shiny App on Google Cloud Run — rshinycloudrun-package","text":"Maintainer: Jimmy Briggs jimmy.briggs@jimbrig.com (ORCID) Authors: Patrick Howard patrick.howard@noclocks.dev [reviewer] contributors: Clocks, LLC team@noclocks.dev [copyright holder, funder]","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/run_app.html","id":null,"dir":"Reference","previous_headings":"","what":"Run the Shiny Application — run_app","title":"Run the Shiny Application — run_app","text":"Run Shiny Application","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/run_app.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run the Shiny Application — run_app","text":"","code":"run_app( onStart = NULL, options = list(), enableBookmarking = NULL, uiPattern = \"/\", ... )"},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/run_app.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run the Shiny Application — run_app","text":"onStart function called app actually run. needed shinyAppObj, since shinyAppDir case, global.R file can used purpose. options Named options passed runApp call (can following: \"port\", \"launch.browser\", \"host\", \"quiet\", \"display.mode\" \"test.mode\"). can also specify width height parameters provide hint embedding environment ideal height/width app. enableBookmarking Can one \"url\", \"server\", \"disable\". default value, NULL, respect setting previous calls enableBookmarking(). See enableBookmarking() information bookmarking app. uiPattern regular expression applied GET request determine whether ui used handle request. Note entire request path must match regular expression order match considered successful. ... arguments pass app_opts.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/news/index.html","id":"rshinycloudrun-development-version","dir":"Changelog","previous_headings":"","what":"rshinycloudrun (development version)","title":"rshinycloudrun (development version)","text":"Initial CRAN submission.","code":""}] +[{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CHANGELOG.html","id":null,"dir":"","previous_headings":"","what":"Changelog","title":"Changelog","text":"notable changes project documented file. format based Keep Changelog project adheres Semantic Versioning.","code":""},{"path":[]},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CHANGELOG.html","id":"bug-fixes","dir":"","previous_headings":"","what":"Bug Fixes","title":"Changelog","text":"Fix GHA (cb752bd) - (Jimmy Briggs) Fix GHA (0f67c58) - (Jimmy Briggs)","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CHANGELOG.html","id":"configuration","dir":"","previous_headings":"","what":"Configuration","title":"Changelog","text":"Tweak ignores (b9c4ad7) - (Jimmy Briggs) Buildignore index.md (2de3533) - (Jimmy Briggs)","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CHANGELOG.html","id":"documentation","dir":"","previous_headings":"","what":"Documentation","title":"Changelog","text":"Separate index.md README.md pkgdown (82ffd12) - (Jimmy Briggs) Add TOC (cf26d28) - (Jimmy Briggs) Add images (4837232) - (Jimmy Briggs) Update README (1988447) - (Jimmy Briggs)","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CHANGELOG.html","id":"features","dir":"","previous_headings":"","what":"Features","title":"Changelog","text":"Bulk update (f42c20a) - (Jimmy Briggs) Update DESCRIPTION (170a352) - (Jimmy Briggs) Add pkgdown (311e384) - (Jimmy Briggs) Add GHA GHCR (docker-ghcr.yml) (57fa3ed) - (Jimmy Briggs) Add terraform infra code docker build GHA (eaacdfd) - (Jimmy Briggs) Add deployment docker (e4d9078) - (Jimmy Briggs) Changelog generated git-cliff. ***","code":""},{"path":[]},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement Clocks, LLC. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 Clocks, LLC Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Jimmy Briggs. Author, maintainer. Patrick Howard. Author, reviewer. Clocks, LLC. Copyright holder, funder.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Briggs J, Howard P (2024). rshinycloudrun: Shiny App Google Cloud Run. R package version 0.0.1, https://docs.noclocks.dev/demo-rshiny-cloudrun/, https://github.com/noclocks/demo-rshiny-cloudrun.","code":"@Manual{, title = {rshinycloudrun: Shiny App on Google Cloud Run}, author = {Jimmy Briggs and Patrick Howard}, year = {2024}, note = {R package version 0.0.1, https://docs.noclocks.dev/demo-rshiny-cloudrun/}, url = {https://github.com/noclocks/demo-rshiny-cloudrun}, }"},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/index.html","id":"contents","dir":"","previous_headings":"","what":"Contents","title":"Shiny App on Google Cloud Run","text":"Badges Overview Installation Usage Pre-Requisites Code Conduct","code":""},{"path":[]},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/index.html","id":"overview","dir":"","previous_headings":"","what":"Overview","title":"Shiny App on Google Cloud Run","text":"repository contains R package demonstrates build deploy R Shiny app Google Cloud Platform’s (GCP) Cloud Run service using Docker.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Shiny App on Google Cloud Run","text":"can install development version rshinycloudrun GitHub preferred installation method : Notice although R package named rshinycloudrun, GitHub repository named demo-rshiny-cloudrun. internal organization purposes affect installation process.","code":"# Install using remotes remotes::install_github(\"noclocks/demo-rshiny-cloudrun\") # Or using devtools devtools::install_github(\"noclocks/demo-rshiny-cloudrun\") # Or using pak pak::pkg_install(\"noclocks/demo-rshiny-cloudrun\")"},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Shiny App on Google Cloud Run","text":"installed, can load package run Shiny app using following commands:","code":"library(rshinycloudrun) run_app()"},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/index.html","id":"deployment","dir":"","previous_headings":"","what":"Deployment","title":"Shiny App on Google Cloud Run","text":"package set build deploy R Shiny app Google Cloud Platform’s (GCP) Cloud Run service using Docker.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/index.html","id":"pre-requisites","dir":"","previous_headings":"Deployment","what":"Pre-Requisites","title":"Shiny App on Google Cloud Run","text":"Google Cloud Platform (GCP) Account Docker Desktop R RStudio R Shiny Google Cloud SDK Google Cloud Run","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/index.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Shiny App on Google Cloud Run","text":"Please note rshinycloudrun package released Contributor Code Conduct. contributing project, agree abide terms. © 2024 Clocks, LLC","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/app_sys.html","id":null,"dir":"Reference","previous_headings":"","what":"App Sys — app_sys","title":"App Sys — app_sys","text":"Access files current app.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/app_sys.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"App Sys — app_sys","text":"","code":"app_sys(...)"},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/app_sys.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"App Sys — app_sys","text":"... (Optional) Character Vector(s) specifying paths file(s) within R package's installation folder. Defaults nothing returns root app package folder.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/app_sys.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"App Sys — app_sys","text":"Character vector positive length, containing file paths matched `...`, empty string, `\"\"`, none matched.","code":""},{"path":[]},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/app_sys.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"App Sys — app_sys","text":"","code":"config_file <- app_sys(\"config/config.yml\") #> Error in app_sys(\"config/config.yml\"): could not find function \"app_sys\""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/get_app_config.html","id":null,"dir":"Reference","previous_headings":"","what":"Get App Config — get_app_config","title":"Get App Config — get_app_config","text":"Retrieves value app package's configuration file, `config.yml`.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/get_app_config.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get App Config — get_app_config","text":"","code":"get_app_config( value, config = Sys.getenv(\"APP_CONFIG_ACTIVE\", Sys.getenv(\"R_CONFIG_ACTIVE\", \"default\")), use_parent = TRUE, file = app_sys(\"config.yml\") )"},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/get_app_config.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get App Config — get_app_config","text":"value (Required) Value retrieve config file. config (Optional) Configuration environment use. Defaults `APP_CONFIG_ACTIVE`'s environment variable, available, , uses `R_CONFIG_ACTIVE`'s environment variable. Finally still unset, defaults `default`. use_parent (Optional) Logical, scan parent directory config file. Defaults `TRUE`. file (Optional) Character path location config file. Defaults `config.yml` file app package's root installation directory via `app_sys(\"config.yml\")`.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/get_app_config.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get App Config — get_app_config","text":"value config file.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/rshinycloudrun-package.html","id":null,"dir":"Reference","previous_headings":"","what":"rshinycloudrun: Shiny App on Google Cloud Run — rshinycloudrun-package","title":"rshinycloudrun: Shiny App on Google Cloud Run — rshinycloudrun-package","text":"Deploy Shiny app Google Cloud Run.","code":""},{"path":[]},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/rshinycloudrun-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"rshinycloudrun: Shiny App on Google Cloud Run — rshinycloudrun-package","text":"Maintainer: Jimmy Briggs jimmy.briggs@jimbrig.com (ORCID) Authors: Patrick Howard patrick.howard@noclocks.dev [reviewer] contributors: Clocks, LLC team@noclocks.dev [copyright holder, funder]","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/run_app.html","id":null,"dir":"Reference","previous_headings":"","what":"Run the Shiny Application — run_app","title":"Run the Shiny Application — run_app","text":"Run Shiny Application","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/run_app.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Run the Shiny Application — run_app","text":"","code":"run_app( onStart = NULL, options = list(), enableBookmarking = NULL, uiPattern = \"/\", ... )"},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/reference/run_app.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Run the Shiny Application — run_app","text":"onStart function called app actually run. needed shinyAppObj, since shinyAppDir case, global.R file can used purpose. options Named options passed runApp call (can following: \"port\", \"launch.browser\", \"host\", \"quiet\", \"display.mode\" \"test.mode\"). can also specify width height parameters provide hint embedding environment ideal height/width app. enableBookmarking Can one \"url\", \"server\", \"disable\". default value, NULL, respect setting previous calls enableBookmarking(). See enableBookmarking() information bookmarking app. uiPattern regular expression applied GET request determine whether ui used handle request. Note entire request path must match regular expression order match considered successful. ... arguments pass app_opts.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/news/index.html","id":"rshinycloudrun-development-version","dir":"Changelog","previous_headings":"","what":"rshinycloudrun (development version)","title":"rshinycloudrun (development version)","text":"Initial CRAN submission.","code":""}]