bind_gantt_data: Bind gantt chart data

View source: R/bind_gantt_data.R

bind_gantt_dataR Documentation

Bind gantt chart data

Description

Bind gantt chart data

Usage

bind_gantt_data(
  .,
  gantt_data = NULL,
  start_date = NULL,
  end_date = NULL,
  task = NULL,
  grouping = NULL,
  color = NULL,
  progress = NULL,
  filter = NULL,
  metadata = NULL
)

Arguments

.

The prior Flourish object. No need to specify name if piping graph as the graph will take the first argument (i.e. the prior existing graph).

gantt_data

Gantt data.

start_date

Start date

end_date

End date. The end date or time of the event. If working with days, the end date should be the first day after the end date. So if your event stretches from 1/1. and ends on the 5/1. your end date should be 6/1. This will mean your Gantt bar will stretch across the last day of your project or task. Flourish type hint: column

task

Task

grouping

Group. Select a categorical column to combine bars into groups on the Y axis. Flourish type hint: column

color

Color category. Select a categorical column; each unique value in the column will become a color. Flourish type hint: column

progress

Progress. Requires a number column with values between 0 and 1, representing the progress from 0 to 100%. Flourish type hint: column

filter

Filter. If set, creates a filter menu or time slider. Flourish type hint: column

metadata

Info for popups. One or more columns of information (text, image URLs, embedded charts etc) to include in popups and panelsFlourish type hint: columns

Value

A Flourish chart

Examples

try(
  flourish(chart_type = "gantt", api_key = Sys.getenv("FLOURISH_API_KEY")) |> 
  bind_gantt_data(gapminder)
)

flourishcharts documentation built on Oct. 30, 2024, 9:07 a.m.