diff --git a/DESCRIPTION b/DESCRIPTION index db6ff6a..9cdff82 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -20,7 +20,7 @@ License: MIT + file LICENSE Encoding: UTF-8 LazyData: TRUE VignetteBuilder: knitr -RoxygenNote: 7.0.2 +RoxygenNote: 7.1.0.9000 Roxygen: list(markdown = TRUE) URL: https://gganimate.com, https://github.com/thomasp85/gganimate BugReports: https://github.com/thomasp85/gganimate/issues diff --git a/R/renderers.R b/R/renderers.R index e7bde9e..303d933 100644 --- a/R/renderers.R +++ b/R/renderers.R @@ -238,6 +238,9 @@ sprite_renderer <- function() { #' #' @param file The gif file to be wrapped #' @param x A `gif_image` object +#' @param f a ‘factor’ in the sense that [as.factor(f)][base::factor] defines +#' the grouping, or a list of such factors in which case their interaction is +#' used for the grouping. #' @inheritParams base::split #' @param ... Arguments passed on #' diff --git a/man/anim_save.Rd b/man/anim_save.Rd index 7d7c742..f6a402b 100644 --- a/man/anim_save.Rd +++ b/man/anim_save.Rd @@ -12,7 +12,9 @@ anim_save(filename, animation = last_animation(), path = NULL, ...) \item{animation}{The animation object to save, as returned by \code{\link[=animate]{animate()}}. Defaults to the last rendered animation using \code{\link[=last_animation]{last_animation()}}} -\item{path}{Path to save plot to (combined with filename).} +\item{path}{Path of the directory to save plot to: \code{path} and \code{filename} +are combined to create the fully qualified file name. Defaults to the +working directory.} \item{...}{arguments passed on to \code{\link[=animate]{animate()}} if \code{animation} is a \code{gganim} object} diff --git a/man/gif_file.Rd b/man/gif_file.Rd index 16a925f..04dfa27 100644 --- a/man/gif_file.Rd +++ b/man/gif_file.Rd @@ -23,9 +23,9 @@ knit_print.gif_image(x, options, ...) \item{...}{Arguments passed on} -\item{f}{a \sQuote{factor} in the sense that \code{\link[base]{as.factor}(f)} - defines the grouping, or a list of such factors in which case their - interaction is used for the grouping.} +\item{f}{a ‘factor’ in the sense that \link[base:factor]{as.factor(f)} defines +the grouping, or a list of such factors in which case their interaction is +used for the grouping.} \item{drop}{logical indicating if levels that do not occur should be dropped (if \code{f} is a \code{factor} or a list).}