get_prj_leads: Get project leads - A list of project leads used in GLIS

View source: R/get_prj_leads.R

get_prj_leadsR Documentation

Get project leads - A list of project leads used in GLIS

Description

This function accesses the api endpoint for project leads and returns their names and usernames. It can fetch the entire table of active project leads, or it accepts the filter parameters to match all or part of a first name, last name, or username.

Usage

get_prj_leads(filter_list = list(), show_id = FALSE, to_upper = TRUE)

Arguments

filter_list

list

show_id

include the fields the 'id' and 'slug' in the returned data frame

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

Details

See https://intra.glis.mnr.gov.on.ca/common/api/v1/swagger/ and filter by "project_leads" for a full list of available filter parameters.

See https://intra.glis.mnr.gov.on.ca/common/project_leads/ for the full list of current and former staff that can be entered as a project lead.

Value

dataframe

Author(s)

Rachel Henderson rachel.henderson@ontario.ca

Examples

## Not run: 
prj_leads <- get_prj_leads()
all_prj_leads <- get_prj_leads(list(all = TRUE))
all_steves <- get_prj_leads(list(first_name__like = "ste", all = TRUE))
prj_lead_slugs <- get_prj_leads(show_id = TRUE)

## End(Not run)

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