diff options
author | Naeem Model <me@nmode.ca> | 2025-01-06 23:55:43 +0000 |
---|---|---|
committer | Naeem Model <me@nmode.ca> | 2025-01-06 23:55:43 +0000 |
commit | e920b3e514e717fc05ed524267d3b53e272fec51 (patch) | |
tree | 353cfb36aca946d69da6d6dcacc0cb66177050ef /man | |
parent | 2d34b71c7a8da7fd0fac59b934145286b2be7b1f (diff) |
Update web app entry point
- Rename 'app' -> 'web'
- Return shiny app object in entry point function
Diffstat (limited to 'man')
-rw-r--r-- | man/app.Rd | 11 | ||||
-rw-r--r-- | man/web.Rd | 31 |
2 files changed, 31 insertions, 11 deletions
diff --git a/man/app.Rd b/man/app.Rd deleted file mode 100644 index f558dc9..0000000 --- a/man/app.Rd +++ /dev/null @@ -1,11 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/app.R -\name{app} -\alias{app} -\title{Launch the Rnaught Web Application} -\usage{ -app() -} -\description{ -Launch the Rnaught Web Application -} diff --git a/man/web.Rd b/man/web.Rd new file mode 100644 index 0000000..36bce07 --- /dev/null +++ b/man/web.Rd @@ -0,0 +1,31 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/web.R +\name{web} +\alias{web} +\title{Launch the Rnaught Web Application} +\usage{ +web() +} +\value{ +A Shiny app object for the Rnaught web application. +} +\description{ +This is the entry point of the Rnaught web application, which creates and +returns a Shiny app object. When invoked directly, the web application is +launched. +} +\details{ +The following dependencies are required to run the application: +\itemize{ +\item \href{https://shiny.posit.co}{shiny} +\item \href{https://rstudio.github.io/bslib}{bslib} +\item \href{https://rstudio.github.io/DT}{DT} +\item \href{https://plotly-r.com}{plotly} +} + +If any of the above packages are missing during launch, a prompt will appear +to install them. + +To configure settings such as the port, host or default browser, set Shiny's +global options (see \code{\link[shiny:runApp]{shiny::runApp()}}). +} |