gp_api_query: Get info for Galactic Polymath units

In galacticpolymath/GPpub: Galactic Polymath Lesson Publishing Tools

Get info for Galactic Polymath units

Description

Constructs a query and requests selected information from the from the galacticpolymath.com/api

Usage

gp_api_query(
  keys = NULL,
  numID = NULL,
  output_tibble = TRUE,
  dev = FALSE,
  id = NULL,
  sort_by = "numID"
)

query_gp_api(
  keys = NULL,
  numID = NULL,
  output_tibble = TRUE,
  dev = FALSE,
  id = NULL,
  sort_by = "numID"
)

Arguments

keys	character vector; which front-matter keys do you want from lessons? default:NULL; use "basic" as shorthand for c("numID","_id","Title"). See all options with get_fm_names()
numID	is a vector of numIDs for unit(s) you want. default=NULL returns all units
output_tibble	return values as a "tibble"? otherwise, list; default=TRUE
dev	logical; if FALSE (default), gets catalog from the production gp-catalog. Otherwise, from the dev catalog.
id	is a vector of ⁠_id⁠s for unit(s) you want. default=NULL returns all units
sort_by	a character giving the column name to sort by. Default="numID"

Value

list of results or tbl_json

Functions

• query_gp_api(): Alias for gp_api_query

See Also

Other GP API: gp_api_get_token(), gp_api_query_users(), gp_api_unit_delete(), gp_api_unit_insert(), gp_api_unit_replace()

galacticpolymath/GPpub documentation built on April 5, 2025, 6:04 p.m.