Filters FORCIS data by a spatial polygon.
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)
#> [1] 2451 77
# Import Indian Ocean spatial polygons ----
file_name <- system.file(file.path("extdata",
"IHO_Indian_ocean_polygon.gpkg"),
package = "forcis")
indian_ocean <- sf::st_read(file_name)
#> Reading layer `IHO_Indian_ocean_polygon' from data source
#> `/home/runner/work/_temp/Library/forcis/extdata/IHO_Indian_ocean_polygon.gpkg'
#> using driver `GPKG'
#> Simple feature collection with 1 feature and 1 field
#> Geometry type: MULTIPOLYGON
#> Dimension: XY
#> Bounding box: xmin: 1508984 ymin: -6336039 xmax: 12568840 ymax: 3246966
#> Projected CRS: +proj=robin +lon_0=0 +x_0=0 +y_0=0 +datum=WGS84 +units=m +no_defs
# Filter by polygon ----
net_data_sub <- filter_by_polygon(net_data, polygon = indian_ocean)
# Dimensions of the data.frame ----
dim(net_data_sub)
#> [1] 1640 77