addtotals

This command is experimental

Definition

addtotals calculates the arithmetic sum for all or selected numeric values per table row. Results appear in a separate table column.

If you use the optional argument col, addtotals also calculates the arithmetic sum for columns. The same can be achieved by using addcoltotals.

Syntax

| addtotals [row=<boolean>] [col=<boolean>] [labelfield=<column>] [label=<string>] [fieldname=<column>] [<column-list>]

Optional arguments

Examples

Use addtotals to calculate the arithmetic sum per row for all numerical values.

%dpl
| makeresults
| eval test=1
| eval test2=3
| addtotals
Example of a basic addtotals query

Column list

List column names to specify, which values addtotals sums per row to the Total column. You can use wildcards in column names to include multiple columns that have, for example, a same prefix. Use a space or a comma to separate values.

%dpl
| makeresults count=2
| eval test=1
| eval test2=3
| eval test3=10
| addtotals col=true test, test3
Example of result where some of the columns are summed together

row

Use row argument to define if the additional Total column is visible. The argument takes a boolean value and is set to TRUE by default.

%dpl
| makeresults
| eval test=1
| eval test2=3
| addtotals row=false
Example of result where row argument is set to false

fieldname

Use fieldname to rename the column name that shows the total sum per row. You can use the argument only when the row argument is set to TRUE.

%dpl
| makeresults
| eval test=1
| eval test2=3
| addtotals fieldname="Total sum"
Example of result where the 'Total' column is renamed with fieldname argument

col

Use col argument to define if the additional summary row is added at the end of results. The argument takes a boolean value and is set to FALSE by default.

%dpl
| makeresults count=5
| eval test=1
| eval test2=3
| addtotals col=true
Example of result where col argument is set to true

labelfield

Use labelfield argument to define which column is used to show the last row’s 'Total' text. The argument works only when col is set to TRUE. If the column doesn’t exist, labelfield will create a new one.

%dpl
| makeresults count=5
| eval test=1
| eval test2=3
| addtotals col=true labelfield=_time

Currently, labelfield doesn’t show results correctly. See the issue on GitHub.

label

Use label to rename the 'Total' text that appears when labelfield argument is used. Both label and labelfield works only when col is set to TRUE.

%dpl
| makeresults count=5
| eval test=1
| eval test2=3
| addtotals col=true labelfield=_time label="Total sum"

Currently, labelfield doesn’t show results correctly. See the issue on GitHub.

Further Reading