nmode's Git Repositories - Rnaught/blob - reference/web.html

   1 <!DOCTYPE html>
   2 <!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Launch the Rnaught Web Application — web • Rnaught</title><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Launch the Rnaught Web Application — web"><meta name="description" content="This is the entry point of the Rnaught web application, which creates and
   3 returns a Shiny app object. When invoked directly, the web application is
   4 launched."><meta property="og:description" content="This is the entry point of the Rnaught web application, which creates and
   5 returns a Shiny app object. When invoked directly, the web application is
   6 launched."><meta property="og:image" content="https://MI2YorkU.github.io/Rnaught/logo.svg"></head><body>
   7     <a href="#main" class="visually-hidden-focusable">Skip to contents</a>
   8
   9
  10     <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">
  11
  12     <a class="navbar-brand me-2" href="../index.html">Rnaught</a>
  13
  14     <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.0</small>
  15
  16
  17     <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
  18       <span class="navbar-toggler-icon"></span>
  19     </button>
  20
  21     <div id="navbar" class="collapse navbar-collapse ms-3">
  22       <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
  23 <li class="nav-item dropdown">
  24   <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  25   <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/seq_bayes_post.html">Sequential Bayes: Utilizing the Posterior Distribution</a></li>
  26     <li><a class="dropdown-item" href="../articles/wp_serial.html">White and Pagano: Utilizing the Serial Distribution</a></li>
  27   </ul></li>
  28       </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
  29  <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
  30 <li class="nav-item"><a class="external-link nav-link" href="https://github.com/MI2YorkU/Rnaught/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
  31       </ul></div>
  32
  33
  34   </div>
  35 </nav><div class="container template-reference-topic">
  36 <div class="row">
  37   <main id="main" class="col-md-9"><div class="page-header">
  38       <img src="../logo.svg" class="logo" alt=""><h1>Launch the Rnaught Web Application</h1>
  39       <small class="dont-index">Source: <a href="https://github.com/MI2YorkU/Rnaught/blob/master/R/web.R" class="external-link"><code>R/web.R</code></a></small>
  40       <div class="d-none name"><code>web.Rd</code></div>
  41     </div>
  42
  43     <div class="ref-description section level2">
  44     <p>This is the entry point of the Rnaught web application, which creates and
  45 returns a Shiny app object. When invoked directly, the web application is
  46 launched.</p>
  47     </div>
  48
  49     <div class="section level2">
  50     <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
  51     <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">web</span><span class="op">(</span><span class="op">)</span></span></code></pre></div>
  52     </div>
  53
  54     <div class="section level2">
  55     <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
  56     <p>A Shiny app object for the Rnaught web application.</p>
  57     </div>
  58     <div class="section level2">
  59     <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
  60     <p>The following dependencies are required to run the application:</p><ul><li><p><a href="https://shiny.posit.co" class="external-link">shiny</a></p></li>
  61 <li><p><a href="https://rstudio.github.io/bslib" class="external-link">bslib</a></p></li>
  62 <li><p><a href="https://rstudio.github.io/DT" class="external-link">DT</a></p></li>
  63 <li><p><a href="https://plotly-r.com" class="external-link">plotly</a></p></li>
  64 </ul><p>If any of the above packages are missing during launch, a prompt will appear
  65 to install them.</p>
  66 <p>To configure settings such as the port, host or default browser, set Shiny's
  67 global options (see <code><a href="https://rdrr.io/pkg/shiny/man/runApp.html" class="external-link">shiny::runApp()</a></code>).</p>
  68     </div>
  69
  70   </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
  71     </nav></aside></div>
  72
  73
  74     <footer><div class="pkgdown-footer-left">
  75   <p>Developed by Naeem Model, Sawitree Boonpatcharanon, Jane Heffernan, Hanna Jankowski.</p>
  76 </div>
  77
  78 <div class="pkgdown-footer-right">
  79   <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p>
  80 </div>
  81
  82     </footer></div>
  83
  84
  85
  86
  87
  88   </body></html>
  89