show_filters: Show filters available on the provided api endpoint

In AdamCottrill/GLFishStockR: Fetch Data From The Great Lakes Fish Stocking API

Show filters available on the provided api endpoint

Description

Many of the GLFSD API endpoints have a number of available filters that allows the response to be taylored to your particular needs. This function takes and api endpoint name and prints out all of the available filters. If 'filter_like' is provided, only those filters that contain the provided string are printed. If no endpoint name is provided, a list of available endpoints will be displayed.

Usage

show_filters(endpoint = "", filter_like = "")

Arguments

endpoint	the name of the api endpoint. If no name is provided, a list of available endpoints will be displayed.
filter_like	a partial string to match filter against

Details

See http://fsis.glfc.org/api/public_urls/ for more information on the available filter keys (query parameters) for each endpoint

Author(s)

Adam Cottrill [e-mail]

Examples

show_filters()
show_filters("strain")
show_filters("events", filter_like = "clip")

AdamCottrill/GLFishStockR documentation built on Sept. 3, 2022, 10:26 p.m.