Aggregate an ocean cube to monthly resolution

to_month() is the compatibility wrapper for monthly temporal aggregation. The built-in mean, sum, min, max, and median functions delegate to cube_aggregate_time(). Arbitrary functions remain temporarily available through the deprecated 0.1.0 materializing path.

Usage

to_month(x, fun = mean)

Arguments

x

An <ocean_cube> object.

fun

Aggregation function. Defaults to mean. The five supported built-ins delegate to cube_aggregate_time(); other functions are deprecated and may materialize the complete input cube.

Value

An <ocean_cube> aggregated to one value per month.

Details

For compatibility, to_month() returns first-day Date timestamps even for POSIXct input and warns when that legacy demotion occurs. Use cube_aggregate_time() to preserve POSIXct input as UTC POSIXct output. Custom fun values use the legacy full-read implementation and emit a deprecation warning.

Lifecycle

Deprecated as of oceancube 0.3.0. Use cube_aggregate_time(x, by = "month") with an explicit supported method.

See also

cube_aggregate_time()