addorgname: addorgname

In PublicHealthEngland/odsR: Extract and manipulate ODS data from the NHS Digital ODS ORD API

Description

Adds Organisation Names to a data.frame containing Organisation Codes using the NHS Digitial ODS ORD API.

Usage

addorgname(
  data,
  CodeCol = "OrgId",
  NameCol = "OrgName",
  insert = TRUE,
  UseProxy = FALSE
)

Arguments

data	data.frame containing the Organisation Codes to add Organisation Names to, unquoted string, no default
CodeCol	the column name from data containing the organisation codes, quoted string, default "OrgId"
NameCol	the name of the column to be added holding organisation names, quoted string, default "OrgName"
insert	whether the new OrgName column should be positioned immediately after the CodeCol column (TRUE or appended to the end of the data frame (FALSE), logical, default TRUE
UseProxy	Whether to use proxy settings to connect to the directory.spineservices.nhs.uk/ODSAPISuite API. If TRUE, the function will look for a UseProxy.csv file in the package library extdata directory. The file must contain a single row of comma separated headers (url, port, username, password, auth) and a second row specifying the values to be passed to each of these httr::use_proxy() function arguments. All Argument headers must be present, leave values blank if not required. Quoted string, default FALSE

Value

returns the original data.frame with Organisation Name column added

Notes

View the NHS Digital ODS API Implementation Guide at https://developer.nhs.uk/library/identifiers/ods-ord-api-implementation-guide/

View the NHS Digital ODS API Suite at https://directory.spineservices.nhs.uk/ODSAPISuite

See Also

Other odsR package functions: OrgRelLkpGP(), OrgRelLkpNHSTrust(), getODSfull(), getODS()

Examples

# add OrgNm column to a data.frame containing a single column (OrgId) of Organisation Codes
codelist <- getODS(Status="Active",PostCode="S80B")[2]
addorgname(codelist)
addorgname(codelist, NameCol="MyNewColumnName", insert=FALSE)

PublicHealthEngland/odsR documentation built on March 4, 2021, 1:57 a.m.