as_reducer: Create a custom reducer

View source: R/reducers.R

as_reducerR Documentation

Create a custom reducer

Description

Reducers are functions that tell the partition algorithm how to reduce the data. as_reducer() is a helper function to create new reducers to be used in partitioners. partitioners can be created with as_partitioner().

Usage

as_reducer(.f, ..., returns_vector = TRUE, first_match = NULL)

Arguments

.f

a function that returns either a numeric vector or a data.frame

...

Extra arguments passed to .f.

returns_vector

logical. Does .f return a vector? TRUE by default. If FALSE, assumes that .f returns a data.frame.

first_match

logical. Should the partition algorithm stop when it finds a reduction that is equal to the threshold? Default is TRUE for reducers that return a data.frame and FALSE for reducers that return a vector

Value

a function to use in as_partitioner()

See Also

Other reducers: reduce_first_component(), reduce_kmeans(), reduce_scaled_mean()

Other reducers: reduce_first_component(), reduce_kmeans(), reduce_scaled_mean()

Examples


reduce_row_means <- as_reducer(rowMeans)
reduce_row_means


USCbiostats/partition documentation built on Feb. 3, 2024, 3:38 a.m.