Class ExperimentResults

constructor

• new ExperimentResults(
      data: RunResult[],
      parameterCombinations: number,
      replications: number,
      elapsedMs: number,
  ): ExperimentResults

  Parameters

  • data: RunResult[]
  • parameterCombinations: number
  • replications: number
  • elapsedMs: number

  Returns ExperimentResults

Readonlydata

aggregate

• aggregate(
      options: {
          groupBy: string[];
          metrics: Record<string, (runs: RunResult[]) => any>;
      },
  ): AggregatedResult[]

  Aggregate results across replications.

  Parameters

  • options: { groupBy: string[]; metrics: Record<string, (runs: RunResult[]) => any> }

  Returns AggregatedResult[]

  Example

  results.aggregate({
    groupBy: ['agentCount', 'speed'],
    metrics: {
      meanPopulation: (runs) => mean(runs.map(r => r.metrics.population)),
      extinctionRate: (runs) => runs.filter(r => r.metrics.population === 0).length / runs.length,
    },
  })
  Copy

filter

• filter(params: Record<string, any>): RunResult[]

  Filter results by parameter values.

  Parameters

  • params: Record<string, any>

  Returns RunResult[]

  Example

  results.filter({ agentCount: 10 })
  results.filter({ agentCount: 10, speed: 2.0 })
  Copy

groupBy

• groupBy(keys: string | string[]): Map<string, RunResult[]>

  Group results by one or more parameter keys.

  Parameters

  • keys: string | string[]

  Returns Map<string, RunResult[]>

  Example

  results.groupBy('agentCount')
  // Returns: Map { 10 => [...runs], 20 => [...runs], 30 => [...runs] }
  
  results.groupBy(['agentCount', 'speed'])
  // Returns: Map { '10,1' => [...runs], '10,2' => [...runs], ... }
  Copy

summary

• summary(): ExperimentSummary

  Get summary statistics about the experiment.

  Returns ExperimentSummary

toCSV

• toCSV(): string

  Export results to CSV string.

  Returns string

toJSON

• toJSON(): RunResult[]

  Export results to JSON object.

  Returns RunResult[]