From bb26a30ff0de7153b7523ae36fa977bc7168111a Mon Sep 17 00:00:00 2001 From: Dean Attali Date: Sat, 19 Aug 2023 21:01:56 -0400 Subject: [PATCH] add correct package file docs (see r-lib/roxygen2#1491) --- DESCRIPTION | 4 ++-- R/shinydisconnect-package.R | 2 ++ man/shinydisconnect-package.Rd | 24 ++++++++++++++++++++++++ 3 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 R/shinydisconnect-package.R create mode 100644 man/shinydisconnect-package.Rd diff --git a/DESCRIPTION b/DESCRIPTION index 66a59bf..a8fa2c8 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -12,7 +12,7 @@ Description: A 'Shiny' app can disconnect for a variety of reasons: an unrecover Works locally (running Shiny apps within 'RStudio') and on Shiny servers (such as shinyapps.io, 'RStudio Connect', 'Shiny Server Open Source', 'Shiny Server Pro'). See demo online at . -URL: https://github.com/daattali/shinydisconnect +URL: https://github.com/daattali/shinydisconnect, https://daattali.com/shiny/shinydisconnect-demo/ BugReports: https://github.com/daattali/shinydisconnect/issues Imports: checkmate, @@ -27,4 +27,4 @@ License: MIT + file LICENSE Encoding: UTF-8 LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.1.0 +RoxygenNote: 7.2.3 diff --git a/R/shinydisconnect-package.R b/R/shinydisconnect-package.R new file mode 100644 index 0000000..0cc9deb --- /dev/null +++ b/R/shinydisconnect-package.R @@ -0,0 +1,2 @@ +#' @keywords internal +"_PACKAGE" diff --git a/man/shinydisconnect-package.Rd b/man/shinydisconnect-package.Rd new file mode 100644 index 0000000..2825649 --- /dev/null +++ b/man/shinydisconnect-package.Rd @@ -0,0 +1,24 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/shinydisconnect-package.R +\docType{package} +\name{shinydisconnect-package} +\alias{shinydisconnect} +\alias{shinydisconnect-package} +\title{shinydisconnect: Show a Nice Message When a 'Shiny' App Disconnects or Errors} +\description{ +A 'Shiny' app can disconnect for a variety of reasons: an unrecoverable error occurred in the app, the server went down, the user lost internet connection, or any other reason that might cause the 'Shiny' app to lose connection to its server. With 'shinydisconnect', you can call disonnectMessage() anywhere in a Shiny app's UI to add a nice message when this happens. Works locally (running Shiny apps within 'RStudio') and on Shiny servers (such as shinyapps.io, 'RStudio Connect', 'Shiny Server Open Source', 'Shiny Server Pro'). See demo online at \url{https://daattali.com/shiny/shinydisconnect-demo/}. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://github.com/daattali/shinydisconnect} + \item \url{https://daattali.com/shiny/shinydisconnect-demo/} + \item Report bugs at \url{https://github.com/daattali/shinydisconnect/issues} +} + +} +\author{ +\strong{Maintainer}: Dean Attali \email{daattali@gmail.com} (\href{https://orcid.org/0000-0002-5645-3493}{ORCID}) [copyright holder] + +} +\keyword{internal}