doc_example: Sum of vector elements.

In yangjl/imputeR: Imputation of GBS genotypes via window phasing

Description

doc_example example.

Usage

doc_example(..., na.rm = TRUE)

Arguments

...	Numeric, complex, or logical vectors.
na.rm	A logical scalar. Should missing values (including NaN) be removed?

Details

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

Value

If all inputs are integer and logical, then the output will be an integer. If integer overflow http://en.wikipedia.org/wiki/Integer_overflow occurs, the output will be NA with a warning. Otherwise it will be a length-one numeric or complex vector.

Zero-length vectors have sum 0 by definition. See http://en.wikipedia.org/wiki/Empty_sum for more details.

Examples

sum(1:10)
sum(1:5, 6:10)
sum(F, F, F, T, T)

sum(.Machine$integer.max, 1L)
sum(.Machine$integer.max, 1)

## Not run: 
sum("a")

## End(Not run)

yangjl/imputeR documentation built on May 4, 2019, 2:28 p.m.