Table 1 List of functions available in coastalNet R-Package, description, user arguments, and outputs.

From: Coastal oceanographic connectivity at the global scale: a dataset of pairwise probabilities and travel times derived from biophysical modeling

Function

Description

Arguments

Output

getDataBase()

Downloads and/or loads the connectivity database.

Folder path to save the database.

Option to overwrite existing database.

Database containing oceanographic connectivity events.

getHexagonID()

Identifies hexagon IDs for a specific location or object.

Spatial object (coordinates, polygon, raster).

Search method (area covered, sites, centroid of sites).

List of hexagon IDs matching the search criteria.

getConnectivityEvents()

Extracts connectivity events from the database.

Hexagon IDs of interest.

Timeframe (year, month, day).

Duration of connectivity events (days).

Data table containing filtered connectivity events.

getPairwiseConnectivity()

Calculates connection strengths between pairs of sites.

Connectivity events data.

List of hexagon IDs to connect from.

List of hexagon IDs to connect to.

Connection metric (probability, number of events, time).

Option to consider stepping-stone connections.

Data tables (squared or pairs) summarizing connection strengths between sites.

Network representing connections between sites.

mapConnectivity()

Visualizes connection strengths on a map.

Connection data (from getPairwiseConnectivity).

Spatial object with lines representing connections.

Back to article page