max.json

{
    "id": "max",
    "summary": "Maximum value",
    "description": "Computes the largest value of an array of numbers, which is is equal to the first element of a sorted (i.e., ordered) version the array.",
    "categories": [
        "math",
        "reducer"
    ],
    "parameter_order": ["data", "ignore_nodata"],
    "parameters": {
        "data": {
            "description": "An array of numbers. An empty array resolves always with `null`.",
            "schema": {
                "type": "array",
                "items": {
                    "type": [
                        "number",
                        "null"
                    ]
                }
            },
            "required": true
        },
        "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
            }
        }
    },
    "returns": {
        "description": "The maximum value.",
        "schema": {
            "type": [
                "number",
                "null"
            ]
        }
    },
    "examples": [
        {
            "arguments": {
                "data": [1,0,3,2]
            },
            "returns": 3
        },
        {
            "arguments": {
                "data": [5,2.5,null,-0.7]
            },
            "returns": 5
        },
        {
            "arguments": {
                "data": [1,0,3,null,2],
                "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/Maximum.html",
            "title": "Maximum explained by Wolfram MathWorld"
        }
    ]
}