R/stat002movies.R

In paulnorthrop/stat0002: Introduction to Probability and Statistics

# ========================== stat0002movies =========================

#' General information about the movies
#'
#' These movies are animations used to illustrate key ideas in STAT0002.
#'
#' @details
#' For a list of movies see
#' \href{https://paulnorthrop.github.io/stat0002/reference/index.html#movies}{Movies}.
#'
#' When one of these functions is called R opens up a small
#' \strong{parameter window} containing clickable buttons that can be
#' used to change parameters underlying the plot. For the effects of
#' these buttons see the documentation of the individual functions below.
#'
#' The parameter window does not close automatically after the movie:
#' the user needs to close it manually.
#'
#' Some movies create objects in the global environment, that is, objects
#' that will be listed when \code{ls()} is used.  \code{rm} can be used to remove
#' these objects if desired.  For example \code{rm(name)} can be used to remove
#' object \code{name}.
#'
#' The \href{https://paulnorthrop.github.io/smovie/}{smovie} package provides
#' a more user-friendly menu from which you can access some of these movies.
#' Use \code{library(smovie)} and then \code{movies()}. See
#' \href{https://paulnorthrop.github.io/smovie/reference/movies.html}{movies}
#' for more details.
#'
#' @return Nothing is returned, only the animation is produced.
#' @section Examples:
#' See the examples given for the individual movies detailed in the
#' \href{https://paulnorthrop.github.io/stat0002/reference/index.html#movies}{Movies}
#' section of the Reference part of the
#' \href{https://paulnorthrop.github.io/stat0002/index.html}{stat0002 home page on GitHub}
#' @name stat0002movies
NULL
## NULL