Quant.Strategy.Optimization.Export (quant v0.1.0-alpha.1)

Export utilities for optimization results.

Provides functionality to export parameter optimization results to various formats including CSV, JSON, and Excel-compatible formats for external analysis.

Summary

Functions

summary(results, filename, opts \\ [])

Export optimization results summary statistics.

to_csv(results, filename, opts \\ [])

Export optimization results to CSV format.

to_json(results, filename, opts \\ [])

Export optimization results to JSON format.

Functions

summary(results, filename, opts \\ [])

@spec summary(Explorer.DataFrame.t(), String.t(), keyword()) ::
  {:ok, String.t()} | {:error, term()}

Export optimization results summary statistics.

Creates a summary report with key statistics from the optimization results including best/worst performance, parameter distributions, and correlation analysis.

Parameters

  • results - DataFrame containing optimization results
  • filename - Output filename (supports .csv, .json extensions)
  • opts - Export options

Examples

# Export summary to CSV
{:ok, path} = Export.summary(results, "optimization_summary.csv")

# Export detailed summary with correlations
{:ok, path} = Export.summary(results, "summary.json",
  include_correlations: true)

to_csv(results, filename, opts \\ [])

@spec to_csv(Explorer.DataFrame.t(), String.t(), keyword()) ::
  {:ok, String.t()} | {:error, term()}

Export optimization results to CSV format.

Parameters

  • results - DataFrame containing optimization results
  • filename - Output filename (with or without .csv extension)
  • opts - Export options

Options

  • :delimiter - CSV delimiter (default: ",")
  • :precision - Decimal precision for float values (default: 4)

Examples

# Basic CSV export
{:ok, path} = Export.to_csv(results, "optimization_results.csv")

# Custom delimiter and precision
{:ok, path} = Export.to_csv(results, "results.csv",
  delimiter: ";", precision: 6)

to_json(results, filename, opts \\ [])

@spec to_json(Explorer.DataFrame.t(), String.t(), keyword()) ::
  {:ok, String.t()} | {:error, term()}

Export optimization results to JSON format.

Parameters

  • results - DataFrame containing optimization results
  • filename - Output filename (with or without .json extension)
  • opts - Export options

Options

  • :precision - Decimal precision for float values (default: 4)
  • :pretty - Pretty print JSON (default: true)

Examples

# Basic JSON export
{:ok, path} = Export.to_json(results, "optimization_results.json")

# Compact JSON without pretty printing
{:ok, path} = Export.to_json(results, "results.json", pretty: false)