Fix argument documentation

R/datamation_tibble.R

@@ -13,6 +13,9 @@
 #' @param pipeline A tidyverse pipeline.
 #' @param envir An environment.
 #' @param output Path to where gif will be saved.
+#' @param titles Optional titles for the datamation frames
+#' @param xlim Optional x limits
+#' @param ylim Optional y limits
 #' @export
 datamation_tibble <- function(pipeline, envir = rlang::global_env(),
                               output = "output.gif", titles = NA,

R/parse_pipeline.R

@@ -7,10 +7,10 @@
 #'
 #' @examples
 #' "small_salary %>% group_by(Degree) %>% summarize(mean = mean(Salary))" %>%
-#'   parse_pipeline()
+#'   datamations:::parse_pipeline()
 #'
 #' "group_by(small_salary, Degree) %>% summarize(mean = mean(Salary))" %>%
-#'   parse_pipeline()
+#'   datamations:::parse_pipeline()
 parse_pipeline <- function(pipeline, supported_tidy_functions = c("group_by", "summarize")) {
   pipeline %>%
     split_pipeline(supported_tidy_functions = supported_tidy_functions) %>%

R/run_app.R

@@ -1,7 +1,5 @@
 #' Run the Shiny Application
 #'
-#' @param ... A series of options to be used inside the app.
-#'
 #' @export
 run_app <- function() {
   shiny::shinyApp(

man/datamation_tibble.Rd

@@ -19,6 +19,12 @@ datamation_tibble(
 \item{envir}{An environment.}
 
 \item{output}{Path to where gif will be saved.}
+
+\item{titles}{Optional titles for the datamation frames}
+
+\item{xlim}{Optional x limits}
+
+\item{ylim}{Optional y limits}
 }
 \description{
 Create a tibble datamation

man/parse_pipeline.Rd

@@ -16,8 +16,8 @@ Parses a tidyverse pipeline, input as a string, into a list of its components as
 }
 \examples{
 "small_salary \%>\% group_by(Degree) \%>\% summarize(mean = mean(Salary))" \%>\%
-  parse_pipeline()
+  datamations:::parse_pipeline()
 
 "group_by(small_salary, Degree) \%>\% summarize(mean = mean(Salary))" \%>\%
-  parse_pipeline()
+  datamations:::parse_pipeline()
 }

man/run_app.Rd

@@ -6,9 +6,6 @@
 \usage{
 run_app()
 }
-\arguments{
-\item{...}{A series of options to be used inside the app.}
-}
 \description{
 Run the Shiny Application
 }