cqc_partner_code: Partner Code

In evanodell/cqcr: Access 'Care Quality Commission' Data

Partner Code

Description

Function to add an identifier code to API queries.

Usage

cqc_partner_code(check_env = FALSE)

Arguments

check_env

If TRUE, will check the environment variable CQC_PARTNER_CODE first before asking for user input.

Details

The CQC wants all organisations using this API to add an additional query identifying themselves to all queries.

According to the CQC's documentation, "If you are a CQC Syndication partner the value for this code will be provided to you, otherwise an informative but concise code representing your organisation should be chosen." The partner code can be set as an environmental variable named CQC_PARTNER_CODE, or using this function. If set, it will automatically be included in all queries. If not set, a message will appear with each data retrieval request reminding you to set a partner code.

evanodell/cqcr documentation built on April 24, 2023, 12:40 a.m.