get_vessels: Get vessels - A list of vessel names used in GLIS

In AdamCottrill/glfishr: Fetch fisheries assessment data from the FN Portal

Get vessels - A list of vessel names used in GLIS

Description

This function accesses the api endpoint for vessels and returns their names, descriptions and whether they're in use. It can fetch the entire table of active vessels, or it accepts filter parameter all=TRUE to return depreciated vessels too. No other filter parameters are currently available for this endpoint.

Usage

get_vessels(filter_list = list(), to_upper = TRUE)

Arguments

filter_list	list
to_upper	should the names of the dataframe be converted to upper case?

Details

See https://intra.glis.mnr.gov.on.ca/common/vessels/ for the full list of vessels

Value

dataframe

Author(s)

Rachel Henderson [e-mail]

Examples

vessel_list <- get_vessels()
all_vessels <- get_vessels(list(all = TRUE))

AdamCottrill/glfishr documentation built on Aug. 9, 2024, 5:47 p.m.