save_mpi: Save MPI output

In mpindex: Multidimensional Poverty Index (MPI) via the Alkire-Foster Method

Save MPI output

Description

Save the MPI output to an Excel file using the tsg package for publication-ready table formatting.

Usage

save_mpi(
  mpi_output,
  mpi_specs,
  ...,
  filename = NULL,
  include_specs = FALSE,
  overall_label = "Overall",
  facade = tsg::get_tsg_facade()
)

Arguments

mpi_output	An object derived from compute_mpi.
mpi_specs	MPI specifications defined in define_mpi_specs.
...	Reserved; passing old dotted names triggers a helpful error.
filename	Output filename. The .xlsx extension is added automatically when missing. Defaults to "MPI Results.xlsx" in the current working directory.
include_specs	Whether to include MPI specification as a separate sheet. Defaults to FALSE.
overall_label	Overall label to assign when grouping is defined in compute_mpi() through by argument. Default is "Overall". Accepts vector of elements matching the number of grouping variables defined.
facade	tsg facade (see add_facade).

Value

Returns the normalized file path of the generated Excel file.

Examples

## Not run: 
mpi_result <- compute_mpi(df_household, mpi_specs = specs, deprivations = deps)
save_mpi(mpi_result, mpi_specs = specs, filename = "MPI Sample Output")

## End(Not run)

mpindex documentation built on Oct. 4, 2026, 5:07 p.m.