Sum of Vector Elements

Description

sum returns the sum of all the valuespresent in its arguments.

Usage

sum(..., na.rm = FALSE)

Arguments

Details

This is a generic function: methods can be defined for itdirectly or via theSummary group generic.For this to work properly, the arguments... should beunnamed, and dispatch is on the first argument.

Ifna.rm isFALSE anNA orNaN value inany of the arguments will cause a value ofNA orNaN tobe returned, otherwiseNA andNaN values are ignored.

Logical true values are regarded as one, false values as zero.For historical reasons,NULL is accepted and treated as if itwereinteger(0).

Loss of accuracy can occur when summing values of different signs:this can even occur for sufficiently long integer inputs if thepartial sums would cause integer overflow. Where possibleextended-precision accumulators are used, typically well supportedwith C99 and newer, but possibly platform-dependent.

Value

The sum. If all of the... arguments are of typeinteger or logical, then the sum isinteger whenpossible and isdouble otherwise. Integer overflow should nolonger happen sinceR version 3.5.0.For other argument types it is a length-one numeric(double) or complex vector.

NB: the sum of an empty set is zero, by definition.

S4 methods

This is part of the S4Summarygroup generic. Methods for it must use the signaturex, ..., na.rm.

‘plotmath’ for the use ofsum in plot annotation.

References

Becker, R. A., Chambers, J. M. and Wilks, A. R. (1988)The New S Language.Wadsworth & Brooks/Cole.

See Also

colSums for row and column sums.

Examples

## Pass a vector to sum, and it will add the elements together.sum(1:5)## Pass several numbers to sum, and it also adds the elements.sum(1, 2, 3, 4, 5)## In fact, you can pass vectors into several arguments, and everything gets added.sum(1:2, 3:5)## If there are missing values, the sum is unknown, i.e., also missing, ....sum(1:5, NA)## ... unless  we exclude missing values explicitly:sum(1:5, NA, na.rm = TRUE)