moveVis (version 0.10.5)

add_labels: Add labels to frames

Description

This function adds character labels such as title or axis labels to animation frames created with frames_spatial.

Usage

add_labels(
  frames,
  title = waiver(),
  subtitle = waiver(),
  caption = waiver(),
  tag = waiver(),
  x = waiver(),
  y = waiver(),
  verbose = TRUE
)

Arguments

frames

list of ggplot2 objects, crated with frames_spatial.

title

character, frame title. If NULL, an existing title of frames is removed. If waiver() (default, see ggplot2::waiver()), an existing title of frames is kept.

subtitle

character, frame subtitle. If NULL, an existing title of frames is removed. If waiver() (default, see ggplot2::waiver()), an existing title of frames is kept.

caption

character, frame caption. If NULL, an existing title of frames is removed. If waiver() (default, see ggplot2::waiver()), an existing title of frames is kept.

tag

character, frame tag. If NULL, an existing title of frames is removed. If waiver() (default, see ggplot2::waiver()), an existing title of frames is kept.

x

character, label of the x axis. If NULL, an existing title of frames is removed. If waiver() (default, see ggplot2::waiver()), an existing title of frames is kept.

y

character, label of the y axis. If NULL, an existing title of frames is removed. If waiver() (default, see ggplot2::waiver()), an existing title of frames is kept.

verbose

logical, if TRUE, messages and progress information are displayed on the console (default).

Value

List of frames.

See Also

frames_spatial frames_graph animate_frames

Examples

# NOT RUN {
library(moveVis)
library(move)

data("move_data", "basemap_data")
m <- align_move(move_data, res = 4, unit = "mins")

# create spatial frames using a custom NDVI base layer
r_list <- basemap_data[[1]]
r_times <- basemap_data[[2]]

# }
# NOT RUN {
frames <- frames_spatial(m, r_list = r_list, r_times = r_times, r_type = "gradient",
                         fade_raster = TRUE)

# add labels to frames:
frames <- add_labels(frames, title = "Example animation using moveVis::add_labels()", 
                     subtitle = "Adding a subtitle to frames created using frames_spatial()",
                     caption = "Projection: Geographical, WGS84. Sources: moveVis examples.",
                     x = "Longitude", y = "Latitude")
# have a look at one frame
frames[[100]]
# }
# NOT RUN {
# }