Specify an animation

tm_animate

Usage

tm_animate_fast(
  by = "VARS__",
  nframes = 60L,
  fps = 24L,
  play = c("loop", "pingpong", "once"),
  dpr = 2,
  ...
)

tm_animate(
  by = "VARS__",
  nframes = 60L,
  fps = 2L,
  play = c("loop", "pingpong", "once"),
  dpr = 2,
  ...
)

Arguments

by

group by variable used to create the animation frames. Note: it is called pages in the core function tm_facets().

nframes

number of animation frames. So far, this only applied experimentally in transition map variables. See the extension package tmap.cartogram.

fps

frames per second. Default: 30 for tm_facets_animate and 2 for tm_facets_animate_slow.

play

how should the animation be played? One of "loop" (default), "pingpong", and "once", where "loop" means that the animation will loop indefinitely, "pingpong" means that it will play forward and then backward, and "once" means that it will play only once.

dpr

device pixel ratio. The ratio between the physical pixel density of a device and its logical pixel density.

...

passed on to tm_facets()

Details

Specify an animation from a tmap plot. This is similar to creating facets with tm_facets(). Instead of showing facets next to each other, they are shown as animation frames. The animation subsequently can be exported to a gif or video file (e.g. mp4) with tmap_animation(). If the tmap plot with tm_animate() is printed, the animation will be previewed. The default tm_animate() will show the individual frames slowly (frame per seconds (fps) set to 2) whereas tm_animate_fast() will show them like a movie (with a fps set to 24).

See also

tm_facets() which is the core function, and tmap_animation() used to save the animation