You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

60 line
2.8KB

  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/plot_helpers.R
  3. \name{static_plot}
  4. \alias{static_plot}
  5. \title{Prints the tiles for a processed dataset statically}
  6. \usage{
  7. static_plot(d, title = "", ..., anim_opts = anim_options(...))
  8. }
  9. \arguments{
  10. \item{d}{a processed dataset}
  11. \item{title}{the title of the plot}
  12. \item{...}{Arguments passed on to \code{anim_options}
  13. \describe{
  14. \item{color_header}{Color of the header row.}
  15. \item{color_other}{Color of the cells that are not highlighted otherwise.}
  16. \item{color_missing}{Color of the missing cells.}
  17. \item{color_fun}{A function that generates the colors for the highlighted
  18. cells, default is \code{\link[scales:brewer_pal]{scales::brewer_pal()}} Set1.}
  19. \item{text_color}{Color of the text of the cells, default is a black or
  20. white, based on the background color of the cell.}
  21. \item{text_family}{Font family for the plot text, default is "Fira Mono". Use
  22. \code{\link[=set_font_size]{set_font_size()}} to set global default font sizes.}
  23. \item{title_family}{Font family for the plot title, default is "Fira Mono".
  24. Use \code{\link[=set_font_size]{set_font_size()}} to set global default font sizes.}
  25. \item{text_size}{Font size of the plot text, default is 5.}
  26. \item{title_size}{Font size of the plot title, default is 17.}
  27. \item{cell_width}{Width of a cell, default is 1.}
  28. \item{cell_height}{Height of a cell, default is 1.}
  29. \item{ease_default}{Default aes easing function. See \code{\link[tweenr:display_ease]{tweenr::display_ease()}}
  30. for more options. The tidyexplain default value is \code{sine-in-out}.}
  31. \item{ease_other}{Additional aes easing options, specified as a named list.
  32. List entries are named with the aesthetic to which the easeing should be
  33. applied, consistent with \code{\link[gganimate:ease_aes]{gganimate::ease_aes()}}. E.g. \code{list(color = "sine")}.}
  34. \item{enter}{Enter fading function applied to objects in the animation. See
  35. \link[gganimate:enter_exit]{gganimate::enter_exit} for a complete list of options. The tidyexplain
  36. default is \code{\link[gganimate:enter_fade]{gganimate::enter_fade()}}.}
  37. \item{exit}{Exit fading function applied to objects in the animation. See
  38. \link[gganimate:enter_exit]{gganimate::enter_exit} for a complete list of options. The tidyexplain
  39. default is \code{\link[gganimate:exit_fade]{gganimate::exit_fade()}}.}
  40. \item{transition_length}{The relative length of the transition. Will be
  41. recycled to match the number of states in the data}
  42. \item{state_length}{The relative length of the pause at the states. Will be
  43. recycled to match the number of states in the data}
  44. }}
  45. \item{anim_opts}{Animation options generated with \code{\link[=anim_options]{anim_options()}}. Overrides
  46. any options set in \code{...}.}
  47. }
  48. \value{
  49. a ggplot
  50. }
  51. \description{
  52. Prints the tiles for a processed dataset statically
  53. }
  54. \examples{
  55. NULL
  56. }