gp_api_unit_delete: Delete a GP unit from the database

In galacticpolymath/GPpub: Galactic Polymath Lesson Publishing Tools

Delete a GP unit from the database

Description

Deletes a unit from MongoDB using the GP API. Does not delete it from Google Drive or GitHub gp-lessons project.

Usage

gp_api_unit_delete(
  WD = "?",
  unit_id = NULL,
  prompt_user = TRUE,
  dev = TRUE,
  verbosity = 1
)

Arguments

WD	working directory, passed to parse_wd();default="?"
unit_id	instead of supplying WD, you can supply the _id directly for the unit that you want to delete.
prompt_user	logical; ask user before deleting and replacing the unit? default=TRUE
dev	logical; if FALSE (default), gets catalog from the production gp-catalog. Otherwise, from the dev catalog.
verbosity	passed to httr2::req_perform(); default=1

Value

success (logical)

See Also

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

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