api_delete: Delete MS Bioscreen data entry

In UCSF-MSLAB/msbwaiter: Tools to Interact with the MS Bioscreen API

Description

api_delete deletes the bioscreen data associated with the specified source_id, external_identifier, and endpoint.

Usage

api_delete(source_id = 1, external_identifier = 100, endpoint,
  base_url = "https://msbioscreen-uat.herokuapp.com/api/v1",
  token = get_token(), verbose_b = TRUE)

Arguments

source_id	source identifer
external_identifier	external identifer
endpoint	the data endpoint of interest. Possible values are "subjects", "attacks", "treatments", and "visits".
base_url	the API base URL.
token	HTTP authorization token. Default is to get environment variable 'MSBWAITER_TOKEN'.
verbose_b	print progress messages as function runs?

Details

Deleting 'subjects' data will also delete the associated 'attacks', 'treatments', and 'visits' data. Deleting 'attacks', 'treatments', or 'visits' data will NOT delete the associated data in any of the other endpoints.

See Also

api_do_action, api_create, api_update

UCSF-MSLAB/msbwaiter documentation built on May 9, 2019, 5:19 p.m.