first: firstItem

Description Usage Arguments Details Note See Also Examples

Description

Aggregate function: returns the first value in a group.

Usage

1
2
3
4
firstItem(x, ...)

## S4 method for signature 'characterOrColumn'
firstItem(x, na.rm = FALSE)

Arguments

x

a character or Column object

...

other arguments, currently unused

na.rm

a logical value indicating whether NA values should be stripped before the computation proceeds.

Details

The function by default returns the first values it sees. It will return the first non-missing value it sees when na.rm is set to true. If all values are missing, then NA is returned. Note: the function is non-deterministic because its results depends on order of rows which may be non-deterministic after a shuffle.

Note

firstItem(characterOrColumn) since 1.4.0

See Also

Other aggregate functions: approxCountDistinct(), avg(), corr(), lastItem()

Examples

1
2
3
4
5
## Not run: 
firstItem(df$c)
firstItem(df$c, TRUE)

## End(Not run)

danzafar/tidyspark documentation built on Sept. 30, 2020, 12:19 p.m.