README.md

In cvdprevent: Wrapper for the 'CVD Prevent' Application Programming Interface

CVD Prevent

The goal of CVD Prevent is to provide an R wrapper to the CVD Prevent application programming interface (API). Users can make API requests through built-in R functions.

The Cardiovascular Disease Prevention Audit (CVDPREVENT) is an England-wide primary care audit that automatically extracts routinely held GP data. The Data & Improvement Tool provides open access to the data, with clear, actionable insights for those tasked with improving cardiovascular health.

Installation

You can install the development version of cvdprevent from GitHub with:

# install.packages("devtools")
devtools::install_github("craig-parylo/cvdprevent")

Alternatively, install the latest stable release from CRAN with:

utils::install.packages("cvdprevent")

Example

This is a basic example which shows you how to solve a common problem:

library(cvdprevent)

## basic example code
cvd_indicator_list() |> 
  head(n = 4)
#> # A tibble: 4 × 12
#>   AxisCharacter DataUpdateInterval FormatDisplayName HighestPriorityNotificati…¹
#>   <chr>         <lgl>              <chr>             <chr>                      
#> 1 %             NA                 Proportion %      <NA>                       
#> 2 %             NA                 Proportion %      <NA>                       
#> 3 %             NA                 Proportion %      <NA>                       
#> 4 %             NA                 Proportion %      <NA>                       
#> # ℹ abbreviated name: ¹​HighestPriorityNotificationType
#> # ℹ 8 more variables: IndicatorCode <chr>, IndicatorFormatID <int>,
#> #   IndicatorID <int>, IndicatorName <chr>, IndicatorOrder <int>,
#> #   IndicatorShortName <chr>, IndicatorStatus <chr>, NotificationCount <int>

See vignette('using_cvdprevent', package = 'cvdprevent') for more guidance on use

cvdprevent documentation built on June 8, 2025, 10:16 a.m.