From 355a97259bdb6c17853ab2f58dc672f6cefd7300 Mon Sep 17 00:00:00 2001 From: jgabry Date: Thu, 5 May 2016 12:38:57 -0400 Subject: [PATCH] more doc templating --- R/launch_shinystan.R | 6 ++---- R/shinystan-objects.R | 4 ++-- R/shinystan-package.R | 4 ++-- man-roxygen/seealso-launch.R | 2 ++ man/as.shinystan.Rd | 7 +++++-- man/launch_shinystan_demo.Rd | 8 ++++---- man/shinystan-package.Rd | 6 ++++-- 7 files changed, 21 insertions(+), 16 deletions(-) create mode 100644 man-roxygen/seealso-launch.R diff --git a/R/launch_shinystan.R b/R/launch_shinystan.R index 5d0b92b3..d76d8b87 100644 --- a/R/launch_shinystan.R +++ b/R/launch_shinystan.R @@ -113,10 +113,8 @@ launch_shinystan <- function(object, #' @param ... Optional arguments to pass to \code{\link[shiny]{runApp}}. #' @return An S4 shinystan object. #' -#' @seealso \code{\link{launch_shinystan}} for launching ShinyStan using your -#' own shinystan objects -#' -#' \code{\link{as.shinystan}} to create shinystan objects +#' @template seealso-launch +#' @template seealso-as.shinystan #' #' @examples #' \dontrun{ diff --git a/R/shinystan-objects.R b/R/shinystan-objects.R index e6e208ac..4df3f2bd 100644 --- a/R/shinystan-objects.R +++ b/R/shinystan-objects.R @@ -82,9 +82,9 @@ shinystan <- setClass( #' \code{is.shinystan} returns \code{TRUE} if the tested object is a shinystan #' object and \code{FALSE} otherwise. #' -#' @seealso \code{\link{launch_shinystan}} to launch the ShinyStan interface -#' using a particular shinystan object +#' @template seealso-launch #' @template seealso-drop_parameters +#' @template seealso-generate_quantity #' setGeneric("as.shinystan", function(X, ...) { standardGeneric("as.shinystan") diff --git a/R/shinystan-package.R b/R/shinystan-package.R index acbd2faf..a313fcce 100644 --- a/R/shinystan-package.R +++ b/R/shinystan-package.R @@ -67,8 +67,8 @@ #' } #' #' @template seealso-as.shinystan -#' @seealso \code{\link{launch_shinystan}} for launching the ShinyStan -#' interface. +#' @template seealso-demo +#' @template seealso-launch #' #' @import ggplot2 #' @import methods diff --git a/man-roxygen/seealso-launch.R b/man-roxygen/seealso-launch.R new file mode 100644 index 00000000..b612ae62 --- /dev/null +++ b/man-roxygen/seealso-launch.R @@ -0,0 +1,2 @@ +#' @seealso \code{\link{launch_shinystan}} to launch the ShinyStan interface +#' using a particular shinystan object. diff --git a/man/as.shinystan.Rd b/man/as.shinystan.Rd index 4ab7188c..bdf00a9a 100644 --- a/man/as.shinystan.Rd +++ b/man/as.shinystan.Rd @@ -159,10 +159,13 @@ launch_shinystan(sso) } \seealso{ -\code{\link{launch_shinystan}} to launch the ShinyStan interface - using a particular shinystan object +\code{\link{launch_shinystan}} to launch the ShinyStan interface + using a particular shinystan object. \code{\link{drop_parameters}} to remove parameters from a shinystan object. + +\code{\link{generate_quantity}} to add a new quantity to a shinystan + object. } diff --git a/man/launch_shinystan_demo.Rd b/man/launch_shinystan_demo.Rd index 395870d5..7a57d1fc 100644 --- a/man/launch_shinystan_demo.Rd +++ b/man/launch_shinystan_demo.Rd @@ -42,9 +42,9 @@ sso_demo <- launch_shinystan_demo() } \seealso{ -\code{\link{launch_shinystan}} for launching ShinyStan using your - own shinystan objects - - \code{\link{as.shinystan}} to create shinystan objects +\code{\link{launch_shinystan}} to launch the ShinyStan interface + using a particular shinystan object. + +\code{\link{as.shinystan}} for creating shinystan objects. } diff --git a/man/shinystan-package.Rd b/man/shinystan-package.Rd index 46991213..d5456da4 100644 --- a/man/shinystan-package.Rd +++ b/man/shinystan-package.Rd @@ -67,7 +67,9 @@ Stan (\url{http://mc-stan.org}) models can be run in R using the \seealso{ \code{\link{as.shinystan}} for creating shinystan objects. -\code{\link{launch_shinystan}} for launching the ShinyStan - interface. +\code{\link{launch_shinystan_demo}} to try a demo. + +\code{\link{launch_shinystan}} to launch the ShinyStan interface + using a particular shinystan object. }