data-raw/gt_doc_images.R

In ddsjoberg/gtsummary: Presentation-Ready Data Summary and Analytic Result Tables

# 1. install pkg that will run and save the documentation images
install.packages(
  "gt.doc.images",
  repos = c(
    ddsjoberg = "https://ddsjoberg.r-universe.dev",
    CRAN = "https://cloud.r-project.org"
  )
)

# 2. Install the most recent version of gtsummary

# 3. Restart R to have a fresh R session.
#    No packages should be loaded, not even gtsummary
#    Any object that is in the global environment may be written over!

# 4. Run the function below to save the images created in the help files.
#    Only objects whose named in `_ex` or `_ex[:digit:]+` are saved.
#    Files will be saved to "~/man/figures/<filename>.png", where the filename
#    is the object name, i.e.'tbl_ae_count_ex1.png'. No example object
#    may overlap throughout the entire package.

# gt.doc.images MUST BE UDPATED TO BE ABLE TO DIRECT THE IMAGES TO ANOTHER FOLDER!
gt.doc.images::save_help_file_images(pkg = "gtsummary", path.output = here::here("man-images"))

# document a single file with
gt.doc.images::save_help_file_images(
  pkg = "gtsummary",
  rd_files = "add_overall.Rd",
  path.output = file.path(here::here(), "man-images")
)

# 5. Shrink png files
gt.doc.images::shrink_help_file_images(pkg = "gtsummary",
                                       path = here::here(),
                                       path.output = file.path(here::here(), "man-images"))

gt.doc.images::shrink_help_file_images(pkg = "gtsummary", image_files = "tbl_strata_ex1.png", path.output = file.path(path, "man-images"))

c(
  "as_kable_extra_ex1_pdf.png", "as_kable_extra_ex2_pdf.png",
  "as_flex_table_ex1.png",
  "gt_output_formats.PNG"
) |>
  purrr::walk(~ webshot2::shrink(here::here("man", "figures", .x)))