plotting

plotting

Core plotting functions for simulations, multisims, and scenarios.

Functions

Name	Description
plot_people	Plot statistics of a population – see People.plot() for documentation
plot_result	Plot a single result – see hpv.Sim.plot_result() for documentation
plot_scen_age_results	Plot age results of a scenario
plot_scens	Plot the results of a scenario – see Scenarios.plot() for documentation
plot_sim	Plot the results of a single simulation – see Sim.plot() for documentation

plot_people

plotting.plot_people(
    people,
    bins=None,
    width=1.0,
    alpha=0.6,
    fig_args=None,
    axis_args=None,
    plot_args=None,
    style_args=None,
    do_show=None,
    fig=None,
)

Plot statistics of a population – see People.plot() for documentation

plot_result

plotting.plot_result(
    key,
    sim=None,
    fig_args=None,
    plot_args=None,
    axis_args=None,
    scatter_args=None,
    date_args=None,
    style_args=None,
    grid=False,
    commaticks=True,
    setylim=True,
    color=None,
    label=None,
    do_show=None,
    do_save=False,
    fig_path=None,
    fig=None,
    ax=None,
    plot_burnin=False,
    **kwargs,
)

Plot a single result – see hpv.Sim.plot_result() for documentation

plot_scen_age_results

plotting.plot_scen_age_results(
    analyzer_ref=0,
    to_plot=None,
    scens=None,
    do_save=None,
    fig_path=None,
    fig_args=None,
    plot_args=None,
    scatter_args=None,
    axis_args=None,
    fill_args=None,
    legend_args=None,
    date_args=None,
    show_args=None,
    style_args=None,
    n_cols=None,
    grid=False,
    commaticks=True,
    setylim=True,
    log_scale=False,
    colors=None,
    labels=None,
    do_show=None,
    sep_figs=False,
    fig=None,
    ax=None,
    plot_burnin=False,
    plot_type='sns.boxplot',
    **kwargs,
)

Plot age results of a scenario

plot_scens

plotting.plot_scens(
    to_plot=None,
    scens=None,
    do_save=None,
    fig_path=None,
    fig_args=None,
    plot_args=None,
    scatter_args=None,
    axis_args=None,
    fill_args=None,
    legend_args=None,
    date_args=None,
    show_args=None,
    style_args=None,
    n_cols=None,
    grid=False,
    commaticks=True,
    setylim=True,
    log_scale=False,
    colors=None,
    labels=None,
    do_show=None,
    sep_figs=False,
    fig=None,
    ax=None,
    plot_burnin=False,
    **kwargs,
)

Plot the results of a scenario – see Scenarios.plot() for documentation

plot_sim

plotting.plot_sim(
    to_plot=None,
    sim=None,
    fig=None,
    ax=None,
    do_save=None,
    fig_path=None,
    fig_args=None,
    plot_args=None,
    scatter_args=None,
    axis_args=None,
    fill_args=None,
    legend_args=None,
    date_args=None,
    show_args=None,
    style_args=None,
    n_cols=None,
    grid=True,
    commaticks=True,
    setylim=True,
    log_scale=False,
    colors=None,
    labels=None,
    do_show=None,
    sep_figs=False,
    plot_burnin=False,
    **kwargs,
)

Plot the results of a single simulation – see Sim.plot() for documentation