`PumasPlots` Docstrings

PlottingUtilities.observations_vs_time — Method

observations_vs_time([model,] subject | population | fit | inspect)
observations_vs_time(figpos, [model,] subject | population | fit | inspect)

Plot observations versus time profiles for the given population. Optionally the associated model can be given as the first argument which can provide more detailed axis labels based on the descriptions and metadata from the model's definition. A single fit or inspect object can be passed in instead of providing the model and population pair.

Keywords

loess: Add a loess fit line to the plot. Default is true.
observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
separate: Choose whether to overlay all plots or place each in a separate subplot.
labels: The custom name to use for each individual series within in the plot such as a scatter or line. Provide a NamedTuple with any of the following keys and your custom label string: observed, and loess.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

color
linewidth
linestyle
marker
markercolor
markersize
loess_color
loess_linestyle
loess_linewidth

PlottingUtilities.subject_fits — Method

subject_fits(inspect | [model], predict)
subject_fits(figpos, inspect | [model], predict)

Plot the population and individual predictions overlaid over observations for the provided observations by ID and the given inspect object, or the combination of a model and the results of predict.

Keywords

ids: Select which subject IDs to display. Can be either a single ID or a Vector of IDs. Note that the type of the ID must match those in the population, i.e. a value 1 is not the same as a "1".
observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
separate: Choose whether to overlay all plots or place each in a separate subplot.
labels: The custom name to use for each individual series within in the plot such as a scatter or line. Provide a NamedTuple with any of the following keys and your custom label string: data, pred, and ipred.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

marker
markersize
markercolor
ipred_color
ipred_linewidth
ipred_linestyle
pred_color
pred_linewidth
pred_linestyle

PumasPlots.autocor_plot — Function

autocor_plot(results::BayesMCMCResults, kw...)

Plot autocorrelations for chains from BayesMCMCResults.

Keyword arguments

subjects = nothing: If set to nothing, the population parameters are plotted. If set to an Int n, the individual parameters of the nth subject are plotted. If set to an AbstractVector{<:Int}, the parameters for all chosen subjects are plotted.
parameters = nothing: If set to nothing, all parameters for the chosen subjects are plotted. If set to a vector of Symbols, only this subset is plotted.
collapse = false: If set to true, all chains are collapsed or concatenated into one chain and plotted as such.
colordim = :chain: If set to :chain, each chain is plotted in a different color. If set to :parameter, each parameter is plotted in a different color. If :chain is chosen, the different parameter values create facets, and vice versa.

Deprecated keyword arguments

linkxaxes: Can be set to :all to link all x axes, to :minimal to link only within columns, and to :none to unlink all x axes. Pass this via AlgebraOfGraphics's generic facet option instead.
linkyaxes: Can be set to :all to link all y axes, to :minimal to link only within rows, and to :none to unlink all y axes. Pass this via AlgebraOfGraphics's generic facet option instead.

PumasPlots.convergence_trace — Function

convergence_trace(fit | inspect)
convergence_trace(figpos, fit | inspect)

Plot the fitting trace for a given fit or inspect object. When a SAEM fit is plotted then traces for $μ$, $Ω$, and $σ$ are plotted, otherwise the -Log-Likelihood and Gradient Norm are plotted side-by-side.

Keywords

trace: select which trace to plot. When plotting into a figure position or axis then only a single trace is plotted, otherwise several can be plotted. Available trace names are as follows:
- @model-based: :loglikelihood and :gradientnorm, or their abbreviations :ll and :gn.
- @emmodel-based: :μ, :Ω, and :σ, or their fullnames :mu, :Omega, and :sigma.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

color
colormap
linewidth
linestyle

PumasPlots.corner_plot! — Method

corner_plot(results::BayesMCMCResults; figure, kw...)
corner_plot!(g::Union{GridPosition, GridSubposition}, results::BayesMCMCResults; kw...)

Creates a corner plot from BayesMCMCResults.

Keyword arguments

parameters = nothing: If set to nothing, all parameters for the chosen subject are plotted. If set to a vector of Symbols, only this subset is plotted.
subject = nothing: If set to nothing, the population parameters are plotted. If set to an Int n, the individual parameters of the nth subject are plotted.
figure: If you use corner_plot (without the !) which creates an implicit Figure, you can pass keyword arguments for the Figure constructor as a NamedTuple with the figure keyword, such as corner_plot(args...; figure = (; size = (500, 600))).

PumasPlots.corner_plot — Method

corner_plot(results::BayesMCMCResults; figure, kw...)
corner_plot!(g::Union{GridPosition, GridSubposition}, results::BayesMCMCResults; kw...)

Creates a corner plot from BayesMCMCResults.

Keyword arguments

parameters = nothing: If set to nothing, all parameters for the chosen subject are plotted. If set to a vector of Symbols, only this subset is plotted.
subject = nothing: If set to nothing, the population parameters are plotted. If set to an Int n, the individual parameters of the nth subject are plotted.
figure: If you use corner_plot (without the !) which creates an implicit Figure, you can pass keyword arguments for the Figure constructor as a NamedTuple with the figure keyword, such as corner_plot(args...; figure = (; size = (500, 600))).

PumasPlots.covariates_check — Function

covariates_check([model,] subject | population | fit | inspect)
covariates_check(figpos, [model,] subject | population | fit | inspect)

Plot a data checkout by ID of the given population. Optionally the associated model may also be passed in as the first argument which can provide more detailed y-axis labels based on the descriptions provided in the model definition. Passing a fit or inspect do not require the model argument as well.

Keywords

covariates: The covariates to be plotted. When not specified then all covariates for the given model will be shown. A subset of covariates can be plotted by providing a Symbol or Vector{Symbol} of covariate names.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Stype Keywords

color
marker
markersize

PumasPlots.covariates_dist — Function

covariates_dist([model,], subject | population | fit | inspect)
covariates_dist(figpos, [model,], subject | population | fit | inspect)

Plot the distribution of covariates for the given population. An optional associated model may be passed in as the first argument which will be used to provide more detailed axis labels based on the metadata and descriptions provided in the model definition, if any. A single fit or inspect object may also be used in place of the model and population arguments.

Keywords

covariates: The covariates to be plotted. When not specified then all covariates for the given model will be shown. A subset of covariates can be plotted by providing a Symbol or Vector{Symbol} of covariate names.
categorical: Select which of the variables should be interpreted as categorical. Provide a vector of symbols corresponding to the names of the categorical variables. By default all variables are treated as continuous.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

color
strokecolor
strokewidth

PumasPlots.cummean_plot — Function

cummean_plot(results::BayesMCMCResults, kw...)

Plot cumulative means for chains from BayesMCMCResults.

Keyword arguments

subjects = nothing: If set to nothing, the population parameters are plotted. If set to an Int n, the individual parameters of the nth subject are plotted. If set to an AbstractVector{<:Int}, the parameters for all chosen subjects are plotted.
parameters = nothing: If set to nothing, all parameters for the chosen subjects are plotted. If set to a vector of Symbols, only this subset is plotted.
collapse = false: If set to true, all chains are collapsed or concatenated into one chain and plotted as such.
colordim = :chain: If set to :chain, each chain is plotted in a different color. If set to :parameter, each parameter is plotted in a different color. If :chain is chosen, the different parameter values create facets, and vice versa.

Deprecated keyword arguments

linkxaxes: Can be set to :all to link all x axes, to :minimal to link only within columns, and to :none to unlink all x axes. Pass this via AlgebraOfGraphics's generic facet option instead.
linkyaxes: Can be set to :all to link all y axes, to :minimal to link only within rows, and to :none to unlink all y axes. Pass this via AlgebraOfGraphics's generic facet option instead.

PumasPlots.density_plot — Function

density_plot(results::BayesMCMCResults)

Plot densities for chains from BayesMCMCResults.

Keyword arguments

subjects = nothing: If set to nothing, the population parameters are plotted. If set to an Int n, the individual parameters of the nth subject are plotted. If set to an AbstractVector{<:Int}, the parameters for all chosen subjects are plotted.
parameters = nothing: If set to nothing, all parameters for the chosen subjects are plotted. If set to a vector of Symbols, only this subset is plotted.
collapse = false: If set to true, all chains are collapsed or concatenated into one chain and plotted as such.
colordim = :chain: If set to :chain, each chain is plotted in a different color. If set to :parameter, each parameter is plotted in a different color. If :chain is chosen, the different parameter values create facets, and vice versa.

Deprecated keyword arguments

linkxaxes: Can be set to :all to link all x axes, to :minimal to link only within columns, and to :none to unlink all x axes. Pass this via AlgebraOfGraphics's generic facet option instead.
linkyaxes: Can be set to :all to link all y axes, to :minimal to link only within rows, and to :none to unlink all y axes. Pass this via AlgebraOfGraphics's generic facet option instead.

PumasPlots.empirical_bayes_dist — Function

empirical_bayes_dist(inspect)
empirical_bayes_dist(figpos, inspect)

Plot the distribution of random effects for the given inspect object. Axis label will be based on the metadata and descriptions provided in the model's definition, if any.

Keywords

ebes: Select which variable, as a Symbol, to plot. By default plots all available. Provide a Vector{Symbol} to plot a subset of all available variables.
zeroline: Include a zeroline in the plot. Default is true.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

color
strokecolor
strokewidth
zeroline_color
zeroline_linestyle
zeroline_linewidth

PumasPlots.empirical_bayes_vs_covariates — Function

empirical_bayes_vs_covariates(inspect)
empirical_bayes_vs_covariates(figpos, inspect)

Plot the random effects versus covariates for the given inspect object. Axis label will be based on the metadata and descriptions provided in the model's definition, if any. Reports the Pearson correlation coefficient r.

Keywords

categorical: Select which of the variables should be interpreted as categorical. Provide a vector of symbols corresponding to the names of the categorical variables. By default all variables are treated as continuous.
covariates: The covariates to be plotted. When not specified then all covariates for the given model will be shown. A subset of covariates can be plotted by providing a Symbol or Vector{Symbol} of covariate names.
ebes: Select which variable, as a Symbol, to plot. By default plots all available. Provide a Vector{Symbol} to plot a subset of all available variables.
zeroline: Include a zeroline in the plot. Default is true.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

color
marker
markersize
zeroline_color
zeroline_linestyle
zeroline_linewidth

PumasPlots.forest_plot — Function

forest_plot(results::BayesMCMCResults; kw...)

Creates a forest plot from BayesMCMCResults.

Keyword arguments

parameters = nothing: If set to nothing, all parameters are plotted. If set to a vector of Symbols, only this subset is plotted.
subject = nothing: If set to nothing, the population parameters are plotted. If set to an Int n, the individual parameters of the nth subject are plotted.
hpd_val = [0.05, 0.2]: A vector of α levels for which highest posterior density intervals are plotted.
q = [0.1, 0.9]: The quantile boundaries that are plotted.
ordered = false: If false, parameters are plotted in the order they have within the results struct or the by the one from parameters if that is not nothing. If true, they are plotted ordered by their median value.

PumasPlots.goodness_of_fit — Function

goodness_of_fit(inspect)

Plot a 2-by-2 grid of subplots for each observation associated with the inspect object. The plots included are:

observations_vs_predictions
observations_vs_ipredictions
wresiduals_vs_time (or npde_vs_time)
iwresiduals_vs_ipredictions (or npde_vs_predictions)

Axis label will be based on the metadata and descriptions provided in the model's definition, if any.

Keywords

loess: Add a loess fit line to the plot. Default is true.
ols: Add an OLS fit line to the plot. Default is true.
observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

loess_color
loess_linestyle
loess_linewidth
ols_color
ols_linestyle
ols_linewidth
marker
markercolor
markersize

PumasPlots.iwresiduals_vs_ipredictions — Function

iwresiduals_vs_ipredictions(inspect | [model], wresiduals, predict)
iwresiduals_vs_ipredictions(figpos, inspect | [model], wresiduals, predict)

Plot the weighted individual residuals versus individual predictions for the given inspect object, or the combination of an optional model and the results of wresiduals and predict.

Axis label will be based on the metadata and descriptions provided in the model's definition, if any.

Keywords

loess: Add a loess fit line to the plot. Default is true.
ols: Add an OLS fit line to the plot. Default is true.
observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
zeroline: Include a zeroline in the plot. Default is true.
labels: The custom name to use for each individual series within in the plot such as a scatter or line. Provide a NamedTuple with any of the following keys and your custom label string: loess, ols, and observed.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

loess_color
loess_linestyle
loess_linewidth
ols_color
ols_linestyle
ols_linewidth
zeroline_color
zeroline_linestyle
zeroline_linewidth
marker
markercolor
markersize

PumasPlots.iwresiduals_vs_time — Function

iwresiduals_vs_time(inspect | [model], wresiduals)
iwresiduals_vs_time(figpos, inspect | [model], wresiduals)

Plot the weighted individual residuals versus time for the given inspect object, or the combination of an optional model and the result of wresiduals.

Axis label will be based on the metadata and descriptions provided in the model's definition, if any.

Keywords

loess: Add a loess fit line to the plot. Default is true.
ols: Add an OLS fit line to the plot. Default is true.
observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
zeroline: Include a zeroline in the plot. Default is true.
labels: The custom name to use for each individual series within in the plot such as a scatter or line. Provide a NamedTuple with any of the following keys and your custom label string: loess, ols, and observed.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

loess_color
loess_linestyle
loess_linewidth
ols_color
ols_linestyle
ols_linewidth
zeroline_color
zeroline_linestyle
zeroline_linewidth
marker
markercolor
markersize

PumasPlots.npde_dist — Function

npde_dist(inspect)
npde_dist(figpos, inspect)

Keywords

observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
zeroline: Include a zeroline in the plot. Default is true.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

color
strokecolor
strokewidth
zeroline_color
zeroline_linestyle
zeroline_linewidth

PumasPlots.npde_vs_covariates — Function

npde_vs_covariates(inspect)
npde_vs_covariates(figpos, inspect)

Keywords

categorical: Select which of the variables should be interpreted as categorical. Provide a vector of symbols corresponding to the names of the categorical variables. By default all variables are treated as continuous.
covariates: The covariates to be plotted. When not specified then all covariates for the given model will be shown. A subset of covariates can be plotted by providing a Symbol or Vector{Symbol} of covariate names.
observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
zeroline: Include a zeroline in the plot. Default is true.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

color
marker
markersize
zeroline_color
zeroline_linestyle
zeroline_linewidth

PumasPlots.npde_vs_predictions — Function

npde_vs_predictions(inspect)
npde_vs_predictions(figpos, inspect)

Keywords

loess: Add a loess fit line to the plot. Default is true.
ols: Add an OLS fit line to the plot. Default is true.
observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
zeroline: Include a zeroline in the plot. Default is true.
labels: The custom name to use for each individual series within in the plot such as a scatter or line. Provide a NamedTuple with any of the following keys and your custom label string: loess, ols, and observed.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

loess_color
loess_linestyle
loess_linewidth
ols_color
ols_linestyle
ols_linewidth
zeroline_color
zeroline_linestyle
zeroline_linewidth
marker
markercolor
markersize

PumasPlots.npde_vs_time — Function

npde_vs_time(inspect)
npde_vs_time(figpos, inspect)

Keywords

loess: Add a loess fit line to the plot. Default is true.
ols: Add an OLS fit line to the plot. Default is true.
observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
zeroline: Include a zeroline in the plot. Default is true.
labels: The custom name to use for each individual series within in the plot such as a scatter or line. Provide a NamedTuple with any of the following keys and your custom label string: loess, ols, and observed.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

loess_color
loess_linestyle
loess_linewidth
ols_color
ols_linestyle
ols_linewidth
zeroline_color
zeroline_linestyle
zeroline_linewidth
marker
markercolor
markersize

PumasPlots.observations_vs_ipredictions — Function

observations_vs_ipredictions(inspect | [model], predict)
observations_vs_ipredictions(figpos, inspect | [model], predict)

Plot observations versus individual predictions for the given inspect object, or the combination of an optional model and the results of predict.

Axis label will be based on the metadata and descriptions provided in the model's definition, if any.

Keywords

identity: Add an identity line to the plot. Default is true.
loess: Add a loess fit line to the plot. Default is true.
ols: Add an OLS fit line to the plot. Default is true.
observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
labels: The custom name to use for each individual series within in the plot such as a scatter or line. Provide a NamedTuple with any of the following keys and your custom label string: identity, loess, ols, and observed.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

identity_color
identity_linewidth
identity_linestyle
loess_color
loess_linestyle
loess_linewidth
ols_color
ols_linestyle
ols_linewidth
marker
markercolor
markersize

PumasPlots.observations_vs_predictions — Function

observations_vs_predictions(inspect | [model], predict)
observations_vs_predictions(figpos, inspect | [model], predict)

Plot observations versus population predictions for the given inspect object, or the combination of an optional model and the results of predict.

Axis label will be based on the metadata and descriptions provided in the model's definition, if any.

Keywords

identity: Add an identity line to the plot. Default is true.
loess: Add a loess fit line to the plot. Default is true.
ols: Add an OLS fit line to the plot. Default is true.
observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
labels: The custom name to use for each individual series within in the plot such as a scatter or line. Provide a NamedTuple with any of the following keys and your custom label string: identity, loess, ols, and observed.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

identity_color
identity_linewidth
identity_linestyle
loess_color
loess_linestyle
loess_linewidth
ols_color
ols_linestyle
ols_linewidth
marker
markercolor
markersize

PumasPlots.ridgeline_plot — Function

ridgeline_plot(results::BayesMCMCResults; kw...)

Creates a ridgeline plot from BayesMCMCResults.

Keyword arguments

parameters = nothing: If set to nothing, all parameters for the chosen subject are plotted. If set to a vector of Symbols, only this subset is plotted.
subject = nothing: If set to nothing, the population parameters are plotted. If set to an Int n, the individual parameters of the nth subject are plotted.
hpd_val = [0.05, 0.2]: A vector of α levels for which highest posterior density intervals are plotted.
q = [0.1, 0.9]: The quantile boundaries that are plotted.
spacer = nothing: If set to nothing, the distance between the ridgelines is chosen using the maximum density value. You can also set this manually to a Real number.
fill_q = true: If true, only the part of the density ride between the quantiles from q is filled. If false, the whole density ridge is filled.
fill_hpd = false: If true, only the part of the density corresponding to the tightest hpd interval is filled.
ordered = false: If false, parameters are plotted in the order they have within the results struct or the by the one from parameters if that is not nothing. If true, they are plotted ordered by their median value.

PumasPlots.sim_plot — Function

sim_plot([model,] simobs)
sim_plot(figpos, [model,] simobs)

Plot simulated model predictions from the result of a simobs call. The model used to simulate may optionally be passed to sim_plot, which is used to provide improved axis labels.

Keywords

ids: Select which subject IDs to display. Can be either a single ID or a Vector of IDs. Note that the type of the ID must match those in the population, i.e. a value 1 is not the same as a "1".
separate: Choose whether to overlay all plots or place each in a separate subplot.
observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
labels: The custom name to use for each individual series within in the plot such as a scatter or line. Provide a NamedTuple with any of the following keys and your custom label string: simulated, and data.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

color
linestyle
linewidth
marker
markercolor
markersize

color and markercolor can both be set to the name of a gradient in which case each subject will use a different color based on partitioning the gradient into discrete colors. See Makie.available_gradients() for the full list of supported colors.

PumasPlots.trace_plot — Function

trace_plot(results::BayesMCMCResults; kw...))

Plot chain traces for chains from BayesMCMCResults.

Keyword arguments

subjects = nothing: If set to nothing, the population parameters are plotted. If set to an Int n, the individual parameters of the nth subject are plotted. If set to an AbstractVector{<:Int}, the parameters for all chosen subjects are plotted.
parameters = nothing: If set to nothing, all parameters for the chosen subjects are plotted. If set to a vector of Symbols, only this subset is plotted.
collapse = false: If set to true, all chains are collapsed or concatenated into one chain and plotted as such.
colordim = :chain: If set to :chain, each chain is plotted in a different color. If set to :parameter, each parameter is plotted in a different color. If :chain is chosen, the different parameter values create facets, and vice versa.

Deprecated keyword arguments

linkxaxes: Can be set to :all to link all x axes, to :minimal to link only within columns, and to :none to unlink all x axes. Pass this via AlgebraOfGraphics's generic facet option instead.
linkyaxes: Can be set to :all to link all y axes, to :minimal to link only within rows, and to :none to unlink all y axes. Pass this via AlgebraOfGraphics's generic facet option instead.

PumasPlots.vpc_plot — Method

vpc_plot!(axis, [model,] vpc)
vpc_plot(figpos, [model,] vpc)
vpc_plot([model,] vpc)

Keywords

ci_bands::Bool show confidence interval band.
group::Tuple select which stratification to display. A tuple of Pair{Symbol,Any} entries.
levels::Union{String,Symbol,Vector} select which levels to display in discrete VPCs.
observations::Bool display a scatter plot of the observations data.
observed_ci::Bool show the observed confidence interval band.
observed_quantiles::Bool show the observed quantiles band.
simquantile_medians::Bool show the simulated quantile median line.
unit_yaxis::Bool set the limits of the y-axis to the unit range, [0, 1].
censored::Symbol either :continuous or :discrete. Used to select which VPC from a censored VPC pair to display.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
legend: Either true or a NamedTuple of keyword arguments to pass to the axislegend function for each created Makie.Axis for the plot.
facet: Control the appearance of faceted plots. Off by default. Either true to use default facet settings which hide decorations, ticks, and labels for subplots aside from the left column and bottom row, or a NamedTuple with the following Bool keys:
- hidexlabels, hideylabels, and hidelabels. Default true. Hides labels that are not on the left or bottom edges.
- hidexticks, hideyticks, and hideticks. Default true. Hides ticks and tick labels that are not on the left or bottom edges.
- linkxaxes, linkyaxes, and linkaxes. Default true. Links the limits of the axes along columns/rows.
- combinexlabels, combineylabels, and combinelabels. Default false. Merges unique labels along the left and bottom edges.
labels: The custom name to use for each individual series within in the plot such as a scatter or line. Provide a NamedTuple with any of the following keys and your custom label string: observed, simulated, observed_ci, simulated_ci, and outliers.

Supported Style Keywords

outlier_color
marker
markercolor
markersize
band_color
observed_color
observed_linewidth
observed_linestyle
simulated_color
simulated_linewidth
simulated_linestyle

PumasPlots.wresiduals_dist — Function

wresiduals_dist(inspect | [model], wresiduals)
wresiduals_dist(figpos, inspect | [model], wresiduals)

Plot the distribution of weighted residuals for the given inspect, or the combination of an optional model and the results of wresiduals.

Axis label will be based on the metadata and descriptions provided in the model's definition, if any.

keywords

observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
type: Select which residuals to plot. Options are :wres and :iwres for weighted population or individual residuals respectively. Default is to plot both.
zeroline: Include a zeroline in the plot. Default is true.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

color
strokecolor
strokewidth
zeroline_color
zeroline_linestyle
zeroline_linewidth

PumasPlots.wresiduals_vs_covariates — Function

wresiduals_vs_covariates(inspect | [model], wresiduals)
wresiduals_vs_covariates(figpos, inspect | [model], wresiduals)

Plot the weighted population residuals versus covariates for the given inspect object, or the combination of an optional model and the results of wresiduals.

Axis label will be based on the metadata and descriptions provided in the model's definition, if any.

Keywords

observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
categorical: Select which of the variables should be interpreted as categorical. Provide a vector of symbols corresponding to the names of the categorical variables. By default all variables are treated as continuous.
type: Select which residuals to plot. Options are :wres and :iwres for weighted population or individual residuals respectively. Default is to plot both.
covariates: The covariates to be plotted. When not specified then all covariates for the given model will be shown. A subset of covariates can be plotted by providing a Symbol or Vector{Symbol} of covariate names.
zeroline: Include a zeroline in the plot. Default is true.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

color
marker
markersize
zeroline_color
zeroline_linestyle
zeroline_linewidth

PumasPlots.wresiduals_vs_predictions — Function

wresiduals_vs_predictions(inspect)
wresiduals_vs_predictions(figpos, inspect)

Plot the weighted residuals versus population predictions for the given inspect object.

Axis label will be based on the metadata and descriptions provided in the model's definition, if any.

Keywords

loess: Add a loess fit line to the plot. Default is true.
ols: Add an OLS fit line to the plot. Default is true.
observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
zeroline: Include a zeroline in the plot. Default is true.
labels: The custom name to use for each individual series within in the plot such as a scatter or line. Provide a NamedTuple with any of the following keys and your custom label string: loess, ols, and observed.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

loess_color
loess_linestyle
loess_linewidth
ols_color
ols_linestyle
ols_linewidth
zeroline_color
zeroline_linestyle
zeroline_linewidth
marker
markercolor
markersize

PumasPlots.wresiduals_vs_time — Function

wresiduals_vs_time(inspect | [model], wresiduals)
wresiduals_vs_time(figpos, inspect | [model], wresiduals)

Plot the weighted residuals versus time for the given inspect object, or the combination of an optional model and the results of wresiduals.

Axis label will be based on the metadata and descriptions provided in the model's definition, if any.

Keywords

loess: Add a loess fit line to the plot. Default is true.
ols: Add an OLS fit line to the plot. Default is true.
observations: The observations to be plotted. When not specified then all observations for the given model will be shown. A subset of observations can be plotted by providing a Symbol or Vector{Symbol} of observation names.
zeroline: Include a zeroline in the plot. Default is true.
labels: The custom name to use for each individual series within in the plot such as a scatter or line. Provide a NamedTuple with any of the following keys and your custom label string: loess, ols, and observed.
paginate: (default false) When true sets the return type of a plot to a Vector{Makie.Figure} rather than Makie.Figure which splits the returned plot over several "pages" if there are too many to fit on a single figure comfortably. See also the limit keyword which can be used to set the limit of figures per page.
limit: Sets the maximum number of axes that can be plotted per page when pagination is active.
rows: Sets the maximum number of rows of subplots to be displayed on each paginated Makie.Figure when pagination is active.
columns: Sets the maximum number of columns of subplots to be displayed on each paginated Makie.Figure when pagination is active.
axis: A key-value object with axis options that gets passed to the underlying AlgebraOfGraphics.draw call.
figure: A key-value object with figure options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)
legend: A key-value object with legend options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.) A legend will be drawn automatically unless legend = (; show = false) is set.
facet: A key-value object with facet options that gets passed to the underlying AlgebraOfGraphics.draw call.
colorbar: A key-value object with colorbar options that gets passed to the underlying AlgebraOfGraphics.draw call. (Does not apply when plotting into an existing figure.)

Supported Style Keywords

loess_color
loess_linestyle
loess_linewidth
ols_color
ols_linestyle
ols_linewidth
zeroline_color
zeroline_linestyle
zeroline_linewidth
marker
markercolor
markersize

PumasPlots Docstrings

`PumasPlots` Docstrings