Skip to contents

Create a stock-oriented spatial mask

Source: R/stock_mask.R
stock_mask.Rd

Create a stock-oriented spatial mask

Usage

stock_mask(x, stock = NULL, lat = NULL, dc = NULL, depth = NULL)

Arguments

x

An <ocean_cube> object.

stock

Optional stock name.

lat

Optional latitude range c(min, max).

dc

Optional distance-to-coast range in nautical miles c(min, max). Requires x$dc to be available.

depth

Optional depth range c(min, max).

Value

An <ocean_mask> object.

Lifecycle

Deprecated as of oceancube 0.3.0. Use cube_crop() for explicit coordinate ranges and cube_mask() for polygon masks. Distance-to-coast filters require an explicit downstream rule; there is no single scientifically equivalent replacement for this stock-oriented helper.