filter_by_bbox: Filter FORCIS data by a spatial bounding box

In FRBCesab/forcis: An R Client to Access the FORCIS Database

Filter FORCIS data by a spatial bounding box

Description

Filters FORCIS data by a spatial bounding box.

Usage

filter_by_bbox(data, bbox)

Arguments

data	a data.frame. One obtained by ⁠read_*_data()⁠ functions.
bbox	an object of class bbox (package sf) or a vector of four numeric values defining a square bounding box. Values must follow this order: minimum longitude (xmin), minimum latitude (ymin), maximum longitude (xmax), and maximum latitude (ymax). Important: if a vector of numeric values is provided, coordinates must be defined in the system WGS 84 (epsg=4326).

Value

A data.frame containing a subset of data for the desired bounding box.

Examples

# Attach the package ----
library("forcis")

# Import example dataset ----
file_name <- system.file(file.path("extdata", "FORCIS_net_sample.csv"), 
                         package = "forcis")

net_data <- read.table(file_name, dec = ".", sep = ";")

# Add 'data_type' column ----
net_data$"data_type" <- "Net"

# Dimensions of the data.frame ----
dim(net_data)

# Filter by oceans ----
net_data_sub <- filter_by_bbox(net_data, bbox = c(45, -61, 82, -24))

# Dimensions of the data.frame ----
dim(net_data_sub)

FRBCesab/forcis documentation built on Oct. 25, 2024, 9:26 a.m.