Skip to contents

clim_day() is the compatibility wrapper for cube_climatology(x, by = "day"). Since 0.2.0 it first computes one daily replicate per year and then gives every valid yearly replicate equal weight. It is intended for daily NetCDF products and event-level linkage.

Usage

clim_day(x, period = NULL, leap = c("feb28", "drop", "keep"), min_n = 1L)

Arguments

x

An <ocean_cube> object.

period

Optional closed base period c(start, end) used to compute the climatology. Date and exact UTC POSIXct semantics follow the source cube.

leap

How to handle February 29. "feb28" combines the February 28 and February 29 daily aggregates within each leap year before that year enters the climatology, preventing leap-year double weighting; "drop" removes February 29 from the base climatology and returns NA for February 29 anomalies unless handled externally; "keep" keeps February 29 as an additional climatological day.

min_n

Minimum number of finite yearly daily replicates required to compute the climatological mean for each cell/day/variable. SD requires at least two valid replicates.

Value

An object of class <ocean_clim>.

Lifecycle

Deprecated as of oceancube 0.3.0. Use cube_climatology(x, by = "day").