save_progress_visualisation()

save_progress_visualisation R Documentation

Save Progress Visualisation

Description

Generates a visualisation of project progress and saves it as HTML and PNG.

Usage 

save_progress_visualisation(
  sel_script,
  sel_store = get_active_config("target_store"),
  output_file = "project_status",
  output_dir = here::here("Documentation/Progress"),
  background_color = "white",
  physics = TRUE,
  level_separation = 250
)

Arguments

sel_script

The script file to be visualised.

sel_store

Path to the targets store directory. Defaults to the value from the active configuration key "target_store".

output_file

The name of the output file (default: "project_status").

output_dir

Directory where the output files will be saved (default: "Documentation/Progress").

background_color

Background color for the visualisation (default: "white").

physics

Logical indicating whether to enable physics simulation in the network graph (default: TRUE).

level_separation

Level separation for the visualisation graph (default: 250).

Details

Uses ‘targets::tar_visnetwork’ to create a network graph and saves two HTML files (full and targets-only) using ‘visNetwork::visSave’, plus a static PNG via ‘webshot2::webshot’. If the browser-backed PNG export fails, the function emits a warning and keeps the HTML outputs so progress saving does not abort the surrounding pipeline run. Files are written to ‘output_dir/<store_name>/’ where ‘<store_name>’ is the last path segment of ‘sel_store’ after the ‘targets/’ directory.

Value

No return value. Called for side effects: saves HTML and PNG files to a store-specific subdirectory within ‘output_dir’.

Back to top