bucky.cli.viz#

bucky viz CLI.

Module Contents#

Classes#

AdmLevel

Enum of allows admin level values for the cli.

Functions#

plot(ctx: typer.Context, input_dir: Optional[pathlib.Path] = typer.Option(None, help='Directory of input data to plot'), output_dir: Optional[pathlib.Path] = typer.Option(None, help='Directory for created plots'), levels: List[AdmLevel] = typer.Option(['adm0', 'adm1'], '--levels', '-l', case_sensitive=False, help='Adm levels to generate plots of'), columns: List[str] = typer.Option(['daily_reported_cases', 'daily_deaths'], '--columns', '-c', help='Columns to plot'), num_proc: int = typer.Option(-1, '--num_proc', '-np', help='Number of parallel procs to use'), n_hist: int = typer.Option(28, '--nhist', '-nh', help='Number of historical days to include in plot'), hist_window_size: int = typer.Option(7, '--window', '-w', help='Window size for rolling mean of plotted historical data points'), plot_hist: bool = typer.Option(True, '--plot_hist', help='Plot historical data points'), plot_fit: bool = typer.Option(True, '--plot_fit', help='Plot historical data fit'), adm_mapping_file: str = typer.Option(None, help='Location of admin mapping file'))

bucky viz plot, produce matplotlib quantile plots from output files.

Attributes#

app

bucky.cli.viz.app[source]#
class bucky.cli.viz.AdmLevel[source]#

Bases: str, enum.Enum

Enum of allows admin level values for the cli.

adm0 = adm0[source]#
adm1 = adm1[source]#
adm2 = adm2[source]#
bucky.cli.viz.plot(ctx: typer.Context, input_dir: Optional[pathlib.Path] = typer.Option(None, help='Directory of input data to plot'), output_dir: Optional[pathlib.Path] = typer.Option(None, help='Directory for created plots'), levels: List[AdmLevel] = typer.Option(['adm0', 'adm1'], '--levels', '-l', case_sensitive=False, help='Adm levels to generate plots of'), columns: List[str] = typer.Option(['daily_reported_cases', 'daily_deaths'], '--columns', '-c', help='Columns to plot'), num_proc: int = typer.Option(- 1, '--num_proc', '-np', help='Number of parallel procs to use'), n_hist: int = typer.Option(28, '--nhist', '-nh', help='Number of historical days to include in plot'), hist_window_size: int = typer.Option(7, '--window', '-w', help='Window size for rolling mean of plotted historical data points'), plot_hist: bool = typer.Option(True, '--plot_hist', help='Plot historical data points'), plot_fit: bool = typer.Option(True, '--plot_fit', help='Plot historical data fit'), adm_mapping_file: str = typer.Option(None, help='Location of admin mapping file'))[source]#

bucky viz plot, produce matplotlib quantile plots from output files.