Skip to content

Main content

Population Summary Calculator Source Code

Browse the implementation files for Population Summary Calculator.
tool.ts typescript
import { parseNumericDataset } from '../../parse/numeric-dataset/tool';
import {
	calculatePopulationSummary as calculatePortablePopulationSummary,
	type PopulationSummary
} from '@tool.io/tools/statistics/population-summary';

export type { PopulationSummary };

export const calculatePopulationSummary = (
	values: readonly number[]
): PopulationSummary | null =>
	calculatePortablePopulationSummary(values);

export const populationSummary = (input: unknown): string => {
	const values = parseNumericDataset(input);
	if (values === null) return '';
	const result = calculatePopulationSummary(values);
	return result === null ? '' : JSON.stringify(result);
};

export const Tool: TypeTool = {
	name: 'Population Summary Calculator',
	slug: 'statistics/population-summary',
	intro:
		'Calculate the count, mean, population variance, and population standard deviation of a dataset.',
	tool: populationSummary,
	i: [
		{
			example: '1, 2, 3, 4, 5',
			help: 'Enter finite numbers separated by common delimiters.',
			label: 'Numbers',
			placeholder: 'Enter a dataset',
			render: 'textarea',
			type: 'text'
		}
	],
	o: [
		{
			example:
				'{"count":5,"mean":3,"standardDeviation":1.4142135623730951,"variance":2}',
			help: 'A JSON summary suitable for display, export, or later tool chaining.',
			label: 'Population Summary',
			placeholder: 'Population summary will appear here...',
			render: 'textarea',
			type: 'text'
		}
	],
	equation:
		'$$\\mu=\\frac{1}{N}\\sum_{i=1}^{N}x_i,\\quad \\sigma^2=\\frac{1}{N}\\sum_{i=1}^{N}(x_i-\\mu)^2$$',
	alternative: [
		{
			title: 'Standard Deviation Calculator',
			url: '/statistics/standard-deviation'
		},
		{
			title: 'Variance Calculator',
			url: '/statistics/variance'
		}
	]
};

export default Tool;

Description

Browse the implementation files for Population Summary Calculator.

References

  1. Tool.io on GitHub
  2. Tool.io TypeScript tools library

Similar or alternative tools