api_update: Update MS Bioscreen data entry

Description Usage Arguments See Also

Description

api_update updates an entry in the bioscreen.

Usage

1
2
3
api_update(sufl_data, endpoint, ignore_colnames = c("first_name",
  "last_name"), base_url = "https://msbioscreen-uat.herokuapp.com/api/v1",
  token = get_token(), verbose_b = TRUE, keep_na = FALSE)

Arguments

sufl_data

a data frame with 1 row and column names that follow the current SUFL specification (1.0). At minimum, sufl_data must contain the identifier columns "source_id" and "external_identifier". For attacks, treatments and visits data, sufl_data must also contain the identifier columns "patient_source_id" and "patient_external_identifier".

endpoint

the data endpoint of interest. Possible values are "subjects", "attacks", "treatments", and "visits".

ignore_colnames

the names of the variables whose values should not be updated in the bioscreen. Set to NULL to allow any variable to be updated in the bioscreen if its value is different in the inputed sufl data set.

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?

keep_na

when there is an NA value in the sufl data set that is not NA in the corresponding bioscreen data entry, should the value in the bioscreen be overwritten to NA? Default is set to FALSE so that non-missing values in the bioscreen are not overwritten to NA.

See Also

api_do_action, api_create, api_delete


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