Fit Plotting

fitplot(model, x, y; p0, kwargs...)
fitplot(x, y; kwargs...)
fitplot(result; kwargs...)

Convenience entry point for the common notebook workflow: fit data and return a plot in one call. Every method returns the named tuple (result::FitResult, figure::Figure). Obtain the primary axis with fit_axis(output.figure) when adding custom Makie content.

The two-array method fitplot(x, y) fits the straight line p[1] * x + p[2]; when p0 is not supplied, the initial slope and intercept are derived from the first and last observations. Pass a model function explicitly for any other model.

show_panel (default true) controls the fit-statistics panel; print_report=true additionally prints the text report.

plot_fit(result; kwargs...)

Create and return a Makie Figure from an existing FitResult. The default layout shows data, fitted model, uncertainty band, and an optional right-side report without requiring manual margin tuning. Use fitplot(model, x, y; ...) when fitting and plotting should happen in one call.

The band is the pointwise nsigma-standard-error band of the fitted curve, propagated from the parameter covariance (band=:confidence, default nsigma=1, pointwise 68.3%, not a simultaneous band). band=:prediction adds the observation uncertainty in y and the first-order contribution of the x uncertainty; band=:none draws no band. The default legend label states the level. The full keyword contract (labels, units, limits, result panel, legend, *_kwargs escape hatches) is on the Fit Plotting documentation page; visual tokens are fields of FitPlotStyle.

The default fit_range=:data stops the fitted curve at the first and last measured x. Use fit_range=:axis to extend it over the padded axis range, or pass xgrid when the curve should stop at a specific domain boundary.

Plotting is provided by the optional CairoMakie extension. Load it with using CairoMakie before calling plot functions. Fitting and text reports work without CairoMakie.

fit_axis(figure; index=1)

Return axis number index from a Makie Figure. The default returns the first axis, which is the primary data axis of a standard ScientificFitting fit figure. Invalid indices raise ArgumentError. This is the stable hook for adding custom Makie content after plot_fit without rebuilding the fit.

add_curve!(axis, f; xgrid=nothing, xspan=nothing, n=400, label=nothing, kwargs...)
add_curve!(axis, x, y; label=nothing, kwargs...)

Add a function-valued or precomputed curve to an existing fit axis. A function is sampled on xgrid (a vector of sample positions), on xspan (an (xmin, xmax) interval sampled at n points), or on the current visible axis range at n points; xgrid takes precedence when both are given. Style defaults follow the active ScientificFitting plot contract unless Makie keyword arguments such as color or linewidth are explicitly supplied.

add_points!(axis, x, y; label=nothing, kwargs...)

Add extra points or derived markers to an existing fit axis. This is intended for thresholds, calibration anchors, extrapolated intersections, and other scientific annotations that should share the plot layout.

add_vline!(axis, x; label=nothing, kwargs...)

Add vertical reference line(s) to an existing fit axis.

add_hline!(axis, y; label=nothing, kwargs...)

Add horizontal reference line(s) to an existing fit axis.

add_vband!(axis, xmin, xmax; label=nothing, kwargs...)

Add a vertical uncertainty band, acceptance region, excluded region, or physical threshold to an existing fit axis.

add_hband!(axis, ymin, ymax; label=nothing, kwargs...)

Add a horizontal uncertainty band, acceptance region, excluded region, or physical threshold to an existing fit axis.

plot_theme(theme=:sans; appearance=:auto, theme_override=Theme())

Return the Makie Theme used by ScientificFitting plots. The maintained visual styles are :sans (sans-serif typography, open axes, grid) and :tex (TeX typography, full frame, no grid); appearance is :light, :dark, or :auto. Use this when composing a custom Makie figure that should remain visually consistent with plot_fit. Axis text, legend entries and legend headings share the light/dark foreground color; explicit Makie attributes or theme_override take precedence.

FitPlotStyle(; kwargs...)

Reusable visual tokens for every ScientificFitting plot function. Each field overrides the corresponding token of the selected theme preset; a nothing field keeps the theme value. Pass one style object to plot_fit, fitplot, plot_residuals, plot_diagnostics, plot_profile, plot_contour, and plot_profile_matrix via their style keyword to keep figures visually consistent. Content and layout choices (what is plotted, labels, panels, legends) remain keywords of the individual plot functions; Makie-level escape hatches remain available through their *_kwargs arguments.

Fields: figure_size, panel_gap, data_color, data_marker, data_markersize, data_strokecolor, data_strokewidth, fit_color, fit_linewidth, band_color, band_alpha, xerr_color, yerr_color, error_linewidth, error_whiskerwidth, secondary_color, reference_color, stats_fontsize, stats_box_color, stats_box_alpha, stats_box_strokecolor, stats_box_strokewidth.

plot_palette(theme=:sans; appearance=:auto)

Return the visual tokens used by a ScientificFitting plot style. Besides data, fit, uncertainty-band, and error-bar defaults, the result exposes typography, layout, and color-safe multi-series tokens for custom Makie figures.

plot_info_panel!(cell; theme=:sans, appearance=:auto,
                 legend_source=nothing, legend_plots=nothing,
                 legend_labels=nothing, model_label=nothing,
                 parameter_lines=Any[], statistic_lines=Any[], kwargs...)

Add a compact, left-aligned information panel to a Makie layout cell and return its GridLayout. theme and appearance use the same readable panel defaults as plot_fit; explicit keywords override them. Supply either legend_source or matching legend_plots/legend_labels, plus already formatted model, parameter, and statistic lines. This low-level helper lets compound figures follow ScientificFitting's information hierarchy without coupling the panel to one FitResult. width sets a wrapping width for plain text; legends and unbreakable TeX expressions retain their natural Makie width rather than being clipped.

resize_plot_to_layout!(figure; axes=nothing, flexible_columns=(1,),
                       minimum_axis_size=(420, 300),
                       preferred_size=size(figure.scene))

Resize a completed Makie figure to its natural layout without sacrificing a readable data area. preferred_size is a lower bound, so requesting a wider figure widens flexible plot columns after fixed-size labels, legends, and panels have the room they need. Automatic axes receive minimum_axis_size only while Makie measures the layout; explicit axis widths and heights remain authoritative. Columns listed in flexible_columns are measured with their current Auto ratio and then changed to Auto(false, ratio), so labels and legends cannot shrink the plot after the final canvas is known. Explicit Fixed and Relative column sizes remain unchanged. Pass nothing for either minimum axis dimension when composing stacked or otherwise constrained axes.

plot_fit applies this step automatically. Call it after adding custom layout content to a figure built with plot_theme and plot_info_panel!.