Module:Average change: Difference between revisions

Module documentation[create] [purge]

You might want to create a documentation page for this Scribunto module.
Editors can experiment in this module's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this module.

local p = {}

-- Main function to calculate average change
function p.main(frame)
    local args = frame.args
    local class = args.class or 'actual'
    local omitOp = args.omitOp or 'no'
    local params = { args[1], args[2], args[3], args[4], args[5] }

    -- Filter out nil values and convert to numbers
    local values = {}
    for _, v in ipairs(params) do
        v = tonumber(v)
        if v then
            table.insert(values, v)
        end
    end

    -- Error if fewer than 2 valid values
    if #values < 2 then
        return 'Error: Insufficient Parameters'
    end

    -- Calculate changes
    local changes = {}
    for i = 1, #values - 1 do
        if class == "percent" then
            table.insert(changes, ((values[i + 1] - values[i]) / values[i]) * 100)
        else
            table.insert(changes, values[i + 1] - values[i])
        end
    end

    -- Calculate average change
    local sum = 0
    for _, change in ipairs(changes) do
        sum = sum + change
    end

    local avgChange = sum / #changes
    local formattedChange = string.format("%.2f", avgChange)

    -- Omit the operator if specified
    if omitOp == "yes" then
        formattedChange = string.gsub(formattedChange, "^%-", "")
    end

    return formattedChange
end

return p