The hardware and bandwidth for this mirror is donated by METANET, the Webhosting and Full Service-Cloud Provider.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]metanet.ch.
ccmReportR is an R package that warps the CCM API with
user friendly functions. The package implements actions from the Salesforce
REST API.
Current features include: - OAuth2.0 authorization - Query records using the REST API
# install from CRAN
install.packages("ccmReportR")
# install the development version from GitHub
# install.packages("devtools")
devtools::install_github("DurhamRegionHARP/ccmReportR")Authorization with CCM implements the OAuth2.0 Device Authorization Grant. After a successful authentication, an access token is stored in the operating system’s keyring program (Keychain on macOS, Credential Store on Windows, etc.) for use in subsequent requests.
library(ccmReportR)
# Start the login process
login()
# You'll be prompted to visit a URL to complete the process
Open a browser and login at: https://mohcontacttracing.my.salesforce.com/setup/connect?user_code=25XPRAfter completing the login process in a web browser, you should see
Login successful! when you return to your R terminal.
Use getCases, getExposures, and
getOutbreaks to get a tibble of data from CCM.
Typically, this is the starting point for most applications. Function
parameters allow you to control how data are filtered and what fields
are returned. Below, we fetch a list of cases from CCM. We specify the
health unit, the data to return, the date range to include, and limit
the results to confirmed cases.
# *N.B.* Health unit names in CCM follow a specific spelling.
myCases <- getCases(
healthUnit = 'Simcoe Muskoka District Health Unit',
columns = c('Id', 'CCM_ReportedDate__c'),
from = "2020-10-12",
to = "2020-10-15 23:59:59",
confirmedOnly = TRUE
)
str(myCases)
# data.frame': 32 obs. of 2 variables:
# $ Id : chr "5005X0000028zhGQAQ" "5005X0000029173QAA" "5005X00000292dEQAQ" "5005X00000293QJQAY" ...
# $ CCM_ReportedDate__c: chr "2020-10-12T12:54:36.000+0000" "2020-10-12T15:43:31.000+0000" "2020-10-12T16:00:00.000+0000" # "2020-10-12T19:18:11.000+0000" ...Use getCaseAttribute, getExposureAttribute,
getOutbreakAttribute to get a tibble of
related information. Currently supported attributes for cases include: -
Exposures - Interventions - Lab Results - Outbreaks - Risk Factors -
Symptoms
For exposures: - Exposure investigations
And for outbreaks: - Exposures - Investigations - Locations
Continuing with our previous example, let’s get the interventions related to our list of cases
interventions <- getCaseAttribute('interventions', myCases$Id)
str(interventions)
# tibble [46 x 8] (S3: tbl_df/tbl/data.frame)
# $ Id : chr [1:46] "a1u5X0000005Q3hQAE" "a1u5X0000005T7xQAE" "a1u5X0000005T87QAE" "a1u5X0000005T8CQAU" ...
# $ Case__c : chr [1:46] "5005X0000028zhGQAQ" "5005X0000029173QAA" "5005X0000029173QAA" "5005X0000029173QAA" ...
# $ RecordType.Name : chr [1:46] "Non-Hospital Intervention" "Non-Hospital Intervention" "Non-Hospital Intervention" "Non-Hospital Intervention" ...
# $ Intervention__c : chr [1:46] "Education" "Education" "Self Monitoring by Client" "Self-Isolation at Private Residence" ...
# $ Intervention_Information__c: chr [1:46] "YES" "YES" "YES" "YES" ...
# $ Hospital_Name__r.Name : chr [1:46] NA NA NA NA ...
# $ Start_Date__c : chr [1:46] "2020-10-12" "2020-10-14" "2020-10-14" "2020-10-14" ...
# $ End_Date__c : chr [1:46] NA NA NA NA ...This project is actively seeking input on how to best serve the community. We want to hear from you! Please file a issue or start a discussion.
This project is an open-source initiative and we welcome all contributions. Thank you to all contributors for your time and support!
These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.