diff --git a/404.html b/404.html index a01b7b9..8eadd98 100644 --- a/404.html +++ b/404.html @@ -1,4 +1,5 @@ - + + @@ -38,19 +39,7 @@
  • Get started
  • Reference
  • Changelog
    • -
  • - -
    - reference -news -main -develop -deps -articles -.git -
    -
    • - + @@ -74,42 +38,31 @@

    All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

    -

    [Unreleased] -

    +

    [Unreleased]

    -

    Bug Fixes -

    -
    +
    -

    Configuration -

    -
    +
    -

    Documentation -

    -
    +
    -

    Features -

    -

    Changelog generated by git-cliff. ***

    - + - + + + - - diff --git a/CODE_OF_CONDUCT.html b/CODE_OF_CONDUCT.html index f5ee1b6..8aa1a9f 100644 --- a/CODE_OF_CONDUCT.html +++ b/CODE_OF_CONDUCT.html @@ -1,24 +1,5 @@ - - - - - - -Contributor Covenant Code of Conduct • rshinycloudrun - - - - - - - - - - - - - - + +Contributor Covenant Code of Conduct • rshinycloudrun Skip to contents @@ -34,30 +15,13 @@ + @@ -71,80 +35,65 @@
    -

    Our Pledge -

    +

    Our Pledge

    We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

    We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

    -

    Our Standards -

    +

    Our Standards

    Examples of behavior that contributes to a positive environment for our community include:

    -
    +
    -

    Enforcement Responsibilities -

    +

    Enforcement Responsibilities

    Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

    Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

    -

    Scope -

    +

    Scope

    This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

    -

    Enforcement -

    +

    Enforcement

    Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at No Clocks, LLC. All complaints will be reviewed and investigated promptly and fairly.

    All community leaders are obligated to respect the privacy and security of the reporter of any incident.

    -

    Enforcement Guidelines -

    +

    Enforcement Guidelines

    Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

    -

    1. Correction -

    +

    1. Correction

    Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

    Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

    -

    2. Warning -

    +

    2. Warning

    Community Impact: A violation through a single incident or series of actions.

    Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

    -

    3. Temporary Ban -

    +

    3. Temporary Ban

    Community Impact: A serious violation of community standards, including sustained inappropriate behavior.

    Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

    -

    4. Permanent Ban -

    +

    4. Permanent Ban

    Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

    Consequence: A permanent ban from any sort of public interaction within the community.

    -

    Attribution -

    +

    Attribution

    This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

    Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder][https://github.com/mozilla/inclusion].

    For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

    @@ -152,8 +101,7 @@

    Attribution -

    + - + + + - - diff --git a/LICENSE-text.html b/LICENSE-text.html index 898a416..a873a79 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -1,24 +1,5 @@ - - - - - - -License • rshinycloudrun - - - - - - - - - - - - - - + +License • rshinycloudrun Skip to contents @@ -34,30 +15,13 @@ + @@ -72,8 +36,7 @@ COPYRIGHT HOLDER: No Clocks, LLC - - + - + + + - - diff --git a/LICENSE.html b/LICENSE.html index 65bad59..343a6ef 100644 --- a/LICENSE.html +++ b/LICENSE.html @@ -1,24 +1,5 @@ - - - - - - -MIT License • rshinycloudrun - - - - - - - - - - - - - - + +MIT License • rshinycloudrun Skip to contents @@ -34,30 +15,13 @@ + @@ -76,8 +40,7 @@

    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.Docker.html b/README.Docker.html index 197b5fb..502a2b0 100644 --- a/README.Docker.html +++ b/README.Docker.html @@ -1,24 +1,5 @@ - - - - - - -NA • rshinycloudrun - - - - - - - - - - - - - - + +NA • rshinycloudrun Skip to contents @@ -34,30 +15,13 @@ + @@ -70,13 +34,11 @@
    -

    Building and running your application -

    +

    Building and running your application

    When you’re ready, start your application by running: docker compose up --build.

    -

    Deploying your application to the cloud -

    +

    Deploying your application to the cloud

    First, build your image, e.g.: docker build -t myapp .. If your cloud uses a different CPU architecture than your development machine (e.g., you are on a Mac M1 and your cloud provider is amd64), you’ll want to build the image for that platform, e.g.: docker build --platform=linux/amd64 -t myapp ..

    Then, push it to your registry, e.g. docker push myregistry.com/myapp.

    Consult Docker’s getting started docs for more detail on building and pushing.

    @@ -84,8 +46,7 @@

    Deploying your application to t -

    + - + + + - - diff --git a/articles/index.html b/articles/index.html index 1ebe26d..f2e9ea8 100644 --- a/articles/index.html +++ b/articles/index.html @@ -1,24 +1,5 @@ - - - - - - -Articles • rshinycloudrun - - - - - - - - - - - - - - + +Articles • rshinycloudrun Skip to contents @@ -34,30 +15,13 @@ + @@ -71,14 +35,10 @@

    All vignettes

    -
    -
    rshinycloudrun
    +
    rshinycloudrun
    -
    -
    - - - +
    + - + + + - - diff --git a/articles/rshinycloudrun.html b/articles/rshinycloudrun.html index 86256cf..ccbc0a5 100644 --- a/articles/rshinycloudrun.html +++ b/articles/rshinycloudrun.html @@ -1,4 +1,5 @@ - + + @@ -37,19 +38,7 @@
  • Get started
  • Reference
  • Changelog
    • -
  • - -
    - reference -news -main -develop -deps -articles -.git -
    -
    • - + @@ -70,8 +34,7 @@

    Authors

    -
    +

    Citation

    @@ -106,8 +68,7 @@

    Citation

    - + - + + + - - diff --git a/index.html b/index.html index 840526b..94be61c 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

    +
    + +
    +
    + + + +
    + + + + + + + diff --git a/news/index.html b/news/index.html index 77d0bce..a1a442e 100644 --- a/news/index.html +++ b/news/index.html @@ -1,24 +1,5 @@ - - - - - - -Changelog • rshinycloudrun - - - - - - - - - - - - - - + +Changelog • rshinycloudrun Skip to contents @@ -34,30 +15,13 @@ + @@ -68,8 +32,7 @@ Source: NEWS.md - - + - + + + - - diff --git a/pkgdown.yml b/pkgdown.yml index 6f8d948..821ed8d 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -1,9 +1,9 @@ -pandoc: '3.4' +pandoc: 3.1.11 pkgdown: 2.1.1 pkgdown_sha: ~ articles: rshinycloudrun: rshinycloudrun.html -last_built: 2024-12-26T19:47Z +last_built: 2024-12-26T19:48Z 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 c819403..9476eaf 100644 --- a/reference/app_sys.html +++ b/reference/app_sys.html @@ -1,26 +1,5 @@ - - - - - - -App Sys — app_sys • rshinycloudrun - - - - - - - - - - - - - - - - + +App Sys — app_sys • rshinycloudrun Skip to contents @@ -36,30 +15,13 @@ + @@ -76,40 +38,32 @@
    -

    Usage -

    +

    Usage

    app_sys(...)
    -

    Arguments -

    +

    Arguments

    -
    -
    ... -
    +
    ...

    (Optional) Character Vector(s) specifying paths and file(s) within the R package's installation folder. Defaults to nothing which returns the root of the app package folder.

    -
    -
    +
    -

    Value -

    +

    Value

    Character vector of positive length, containing the file paths that matched `...`, or the empty string, `""`, if none matched.

    -

    See also -

    +

    See also

    [system.file()]

    - + - + + + - - diff --git a/reference/get_app_config.html b/reference/get_app_config.html index fee168b..1265b3b 100644 --- a/reference/get_app_config.html +++ b/reference/get_app_config.html @@ -1,26 +1,5 @@ - - - - - - -Get App Config — get_app_config • rshinycloudrun - - - - - - - - - - - - - - - - + +Get App Config — get_app_config • rshinycloudrun Skip to contents @@ -36,30 +15,13 @@ + @@ -76,8 +38,7 @@
    -

    Usage -

    +

    Usage

    get_app_config(
   value,
   config = Sys.getenv("APP_CONFIG_ACTIVE", Sys.getenv("R_CONFIG_ACTIVE", "default")),
@@ -87,47 +48,38 @@ 
    Usage
    -

    Arguments -

    +

    Arguments

    -
    -
    value -
    +
    value

    (Required) Value to retrieve from the config file.

    -
    config -
    +
    config

    (Optional) Configuration environment to use. Defaults to the `APP_CONFIG_ACTIVE`'s environment variable, if available, and if not, uses `R_CONFIG_ACTIVE`'s environment variable. Finally if still unset, defaults to `default`.

    -
    use_parent -
    +
    use_parent

    (Optional) Logical, scan the parent directory for config file. Defaults to `TRUE`.

    -
    file -
    +
    file

    (Optional) Character path to the location of the config file. Defaults to the `config.yml` file in the app package's root installation directory via `app_sys("config.yml")`.

    -
    -
    +
    -

    Value -

    +

    Value

    The value from the config file.

    - + - + + + - - diff --git a/reference/index.html b/reference/index.html index 103691a..8310876 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1,24 +1,5 @@ - - - - - - -Package index • rshinycloudrun - - - - - - - - - - - - - - + +Package index • rshinycloudrun Skip to contents @@ -34,30 +15,13 @@ + @@ -68,45 +32,36 @@
    -

    All functions -

    +

    All functions

    -
    -
    +
    -
    -
    +
    app_sys()
    App Sys
    -
    -
    -
    +
    get_app_config()
    Get App Config
    -
    -
    -
    +
    run_app()
    Run the Shiny Application
    -
    -
    - - + + - + + + - - diff --git a/reference/rshinycloudrun-package.html b/reference/rshinycloudrun-package.html index 2edd2eb..0fbd27c 100644 --- a/reference/rshinycloudrun-package.html +++ b/reference/rshinycloudrun-package.html @@ -1,28 +1,7 @@ - - - - - - -rshinycloudrun: Shiny App on Google Cloud Run — rshinycloudrun-package • rshinycloudrun - - - - - - - - - - - - - - - - + +rshinycloudrun: Shiny App on Google Cloud Run — rshinycloudrun-package • rshinycloudrun Skip to contents @@ -38,30 +17,13 @@ + @@ -80,34 +42,21 @@
    -

    See also -

    -
    -

    Useful links:

    -
    -

    Author -

    +

    Author

    Maintainer: Jimmy Briggs jimmy.briggs@jimbrig.com (ORCID)

    -

    Authors:

    - -

    Other contributors:

    - -
    +

    Authors:

    Other contributors:

    - + - + + + - - diff --git a/reference/run_app.html b/reference/run_app.html index d8e132f..f5b074b 100644 --- a/reference/run_app.html +++ b/reference/run_app.html @@ -1,26 +1,5 @@ - - - - - - -Run the Shiny Application — run_app • rshinycloudrun - - - - - - - - - - - - - - - - + +Run the Shiny Application — run_app • rshinycloudrun Skip to contents @@ -36,30 +15,13 @@ + @@ -76,8 +38,7 @@
    -

    Usage -

    +

    Usage

    run_app(
   onStart = NULL,
   options = list(),
@@ -88,20 +49,16 @@ 
    Usage
    -

    Arguments -

    +

    Arguments

    -
    -
    onStart -
    +
    onStart

    A function that will be called before the app is actually run. This is only needed for shinyAppObj, since in the shinyAppDir case, a global.R file can be used for this purpose.

    -
    options -
    +
    options

    Named options that should be passed to the runApp call (these can be any of the following: "port", "launch.browser", "host", "quiet", "display.mode" and "test.mode"). You can also specify width and @@ -109,32 +66,27 @@

    ArgumentsenableBookmarking - +
    enableBookmarking

    Can be one of "url", "server", or "disable". The default value, NULL, will respect the setting from any previous calls to enableBookmarking(). See enableBookmarking() for more information on bookmarking your app.

    -
    uiPattern -
    +
    uiPattern

    A regular expression that will be applied to each GET request to determine whether the ui should be used to handle the request. Note that the entire request path must match the regular expression in order for the match to be considered successful.

    -
    ... -
    +
    ...

    arguments to pass to app_opts.

    -

    -
    +
    - + - + + + - - diff --git a/search.json b/search.json index c08b1e7..2f437b1 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":"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":"README (92dd093) - (Jimmy Briggs) Add badges (939c27c) - (Jimmy Briggs) 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":"Add compose.yml (a8add00) - (Jimmy Briggs) Update wordlist namespace (7fd4166) - (Jimmy Briggs) Update deployment Dockerfile (c3ad356) - (Jimmy Briggs) Update docker (66a93d6) - (Jimmy Briggs) Fixes (8fd2ab5) - (Jimmy Briggs) 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/README.Docker.html","id":"building-and-running-your-application","dir":"","previous_headings":"","what":"Building and running your application","title":"NA","text":"’re ready, start application running: docker compose --build.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/README.Docker.html","id":"deploying-your-application-to-the-cloud","dir":"","previous_headings":"","what":"Deploying your application to the cloud","title":"NA","text":"First, build image, e.g.: docker build -t myapp .. cloud uses different CPU architecture development machine (e.g., Mac M1 cloud provider amd64), ’ll want build image platform, e.g.: docker build --platform=linux/amd64 -t myapp .. , push registry, e.g. docker push myregistry.com/myapp. Consult Docker’s getting started docs detail building pushing.","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/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/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":"New URL (61be24b) - (Jimmy Briggs) README (92dd093) - (Jimmy Briggs) Add badges (939c27c) - (Jimmy Briggs) 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":"Add compose.yml (a8add00) - (Jimmy Briggs) Update wordlist namespace (7fd4166) - (Jimmy Briggs) Update deployment Dockerfile (c3ad356) - (Jimmy Briggs) Update docker (66a93d6) - (Jimmy Briggs) Fixes (8fd2ab5) - (Jimmy Briggs) 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/README.Docker.html","id":"building-and-running-your-application","dir":"","previous_headings":"","what":"Building and running your application","title":"NA","text":"’re ready, start application running: docker compose --build.","code":""},{"path":"https://docs.noclocks.dev/demo-rshiny-cloudrun/README.Docker.html","id":"deploying-your-application-to-the-cloud","dir":"","previous_headings":"","what":"Deploying your application to the cloud","title":"NA","text":"First, build image, e.g.: docker build -t myapp .. cloud uses different CPU architecture development machine (e.g., Mac M1 cloud provider amd64), ’ll want build image platform, e.g.: docker build --platform=linux/amd64 -t myapp .. , push registry, e.g. docker push myregistry.com/myapp. Consult Docker’s getting started docs detail building pushing.","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/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":""}]