more doc templating

Cole-Monnahan-NOAA · May 5, 2016 · 355a972 · 355a972
1 parent dfeb021
commit 355a972
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 16 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
diff --git a/man/launch_shinystan_demo.Rd b/man/launch_shinystan_demo.Rd
diff --git a/man/shinystan-package.Rd b/man/shinystan-package.Rd
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		#' @seealso \code{\link{launch_shinystan}} to launch the ShinyStan interface
		#' using a particular shinystan object.