save_mpi {mpindex} | R Documentation |
Save MPI output
Description
Save the MPI output into an Excel file format.
Usage
save_mpi(
.mpi_output,
.mpi_specs = getOption("mpi_specs"),
.filename = NULL,
.formatted_output = TRUE,
.include_table_summary = TRUE,
.include_specs = FALSE
)
Arguments
.mpi_output |
An object derived from compute_mpi. |
.mpi_specs |
MPI specifications defined in |
.filename |
Output filename |
.formatted_output |
Whether formatting is to be applied to the output. |
.include_table_summary |
NOT YET IMPLEMENTED. Whether to include summary information in the generated output. |
.include_specs |
Whether to include MPI specification in the generated output. |
Value
Returns the file location of the output generated.
Examples
## Not run:
# It requires an MPI output (list type) in the first argument
save_mpi(mpi_result, .filename = "MPI Sample Output")
## End(Not run)
[Package mpindex version 0.2.1 Index]