mean.json

{
    "id": "mean",
    "summary": "Arithmetic mean (average)",
    "description": "The arithmetic mean of an array of numbers is the quantity commonly called the average. It is defined as the sum of all elements divided by the number of elements.",
    "categories": [
        "math",
        "reducer"
    ],
    "parameters": [
        {
            "name": "data",
            "description": "An array of numbers. An empty array resolves always with `null`.",
            "schema": {
                "type": "array",
                "items": {
                    "type": [
                        "number",
                        "null"
                    ]
                }
            }
        },
        {
            "name": "ignore_nodata",
            "description": "Indicates whether no-data values are ignored or not. Ignores them by default. Setting this flag to `false` considers no-data values so that `null` is returned if any value is such a value.",
            "schema": {
                "type": "boolean"
            },
            "default": true,
            "optional": true
        }
    ],
    "returns": {
        "description": "The computed arithmetic mean.",
        "schema": {
            "type": [
                "number",
                "null"
            ]
        }
    },
    "examples": [
        {
            "arguments": {
                "data": [
                    1,
                    0,
                    3,
                    2
                ]
            },
            "returns": 1.5
        },
        {
            "arguments": {
                "data": [
                    9,
                    2.5,
                    null,
                    -2.5
                ]
            },
            "returns": 3
        },
        {
            "arguments": {
                "data": [
                    1,
                    null
                ],
                "ignore_nodata": false
            },
            "returns": null
        },
        {
            "description": "The input array is empty: return `null`.",
            "arguments": {
                "data": []
            },
            "returns": null
        }
    ],
    "links": [
        {
            "rel": "about",
            "href": "http://mathworld.wolfram.com/ArithmeticMean.html",
            "title": "Arithmetic mean explained by Wolfram MathWorld"
        }
    ]
}