api_delete_batch: Delete MS Bioscreen data entries

Description Usage Arguments Details See Also

Description

api_delete_batch deletes all the bioscreen data entries associated with the specified source_ids, and endpoint.

Usage

1
2
3
api_delete_batch(source_ids, endpoint,
  base_url = "https://msbioscreen-uat.herokuapp.com/api/v1",
  token = get_token(), verbose_b = TRUE)

Arguments

source_ids

source identifers

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_delete


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