Package: brightspaceR 0.1.0

brightspaceR: Access D2L 'Brightspace' Data Sets via the 'BDS' API

Connect to the D2L 'Brightspace' Data Sets ('BDS') API via 'OAuth2', download all available datasets as tidy data frames with proper types, join them using convenience functions that know the foreign key relationships, and analyse student engagement, performance, and retention with ready-made analytics functions.

Authors:Peeyoosh Chandra [aut, cre]

brightspaceR_0.1.0.tar.gz
brightspaceR_0.1.0.zip(r-4.7)brightspaceR_0.1.0.zip(r-4.6)brightspaceR_0.1.0.zip(r-4.5)
brightspaceR_0.1.0.tgz(r-4.6-any)brightspaceR_0.1.0.tgz(r-4.5-any)
brightspaceR_0.1.0.tar.gz(r-4.7-any)brightspaceR_0.1.0.tar.gz(r-4.6-any)
brightspaceR_0.1.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
card.svg |card.png
brightspaceR/json (API)
NEWS

# Install 'brightspaceR' in R:
install.packages('brightspaceR', repos = c('https://pcstrategyandopsco.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/pcstrategyandopsco/brightspacer/issues

Pkgdown/docs site:https://pcstrategyandopsco.github.io

On CRAN:

Conda:

5.43 score 2 stars 502 downloads 54 exports 39 dependencies

Last updated from:76ccde0c0e. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK120
source / vignettesOK178
linux-release-x86_64OK134
macos-release-arm64OK98
macos-oldrel-arm64OK98
windows-develOK121
windows-releaseOK121
windows-oldrelOK95
wasm-releaseOK115

Exports:bs_ads_filterbs_ads_job_statusbs_api_versionbs_apply_diffsbs_apply_field_policybs_assessment_performancebs_assignment_completionbs_authbs_auth_refreshbs_auth_tokenbs_check_scopesbs_clean_namesbs_configbs_config_setbs_course_engagementbs_course_summarybs_create_ads_jobbs_deauthbs_diff_manifestbs_download_adsbs_download_allbs_download_datasetbs_engagement_scorebs_engagement_summarybs_enrich_enrollmentsbs_filter_test_usersbs_get_adsbs_get_ads_schemabs_get_datasetbs_get_dataset_currentbs_get_schemabs_get_timezonebs_grade_summarybs_has_tokenbs_identify_at_riskbs_joinbs_join_content_progressbs_join_enrollments_gradesbs_join_enrollments_orgunitsbs_join_enrollments_rolesbs_join_grades_objectsbs_join_users_enrollmentsbs_list_adsbs_list_ads_jobsbs_list_ads_schemasbs_list_datasetsbs_list_extractsbs_list_schemasbs_org_idbs_pseudonymise_dfbs_pseudonymise_idbs_retention_summarybs_set_timezonebs_summarize_enrollments

Dependencies:askpassbitbit64clicliprconfigcpp11crayoncurldplyrgenericsgluehmshttr2lifecyclelubridatemagrittropensslpillarpkgconfigprettyunitsprogresspurrrR6rappdirsreadrrlangstringistringrsystibbletidyselecttimechangetzdbutf8vctrsvroomwithryaml

Building an Interactive Dashboard

Rendered frominteractive-dashboard.Rmdusingknitr::rmarkdownon May 17 2026.

Last update: 2026-03-06
Started: 2026-03-06

Convenience Functions: Joins, Schemas, and Data Wrangling

Rendered fromconvenience-functions.Rmdusingknitr::rmarkdownon May 17 2026.

Last update: 2026-03-06
Started: 2026-03-06

Getting Started with brightspaceR

Rendered fromgetting-started.Rmdusingknitr::rmarkdownon May 17 2026.

Last update: 2026-03-08
Started: 2026-03-06

MCP Server Setup

Rendered frommcp-setup.Rmdusingknitr::rmarkdownon May 17 2026.

Last update: 2026-03-18
Started: 2026-03-08

MCP Server Test Script

Rendered frommcp-test-script.Rmdusingknitr::rmarkdownon May 17 2026.

Last update: 2026-03-18
Started: 2026-03-06

MCP Server: Design and Implementation

Rendered frommcp-server-design.Rmdusingknitr::rmarkdownon May 17 2026.

Last update: 2026-03-18
Started: 2026-03-06

OAuth2 Setup for Brightspace Data Sets

Rendered fromsetup.Rmdusingknitr::rmarkdownon May 17 2026.

Last update: 2026-03-10
Started: 2026-03-06

Privacy Compliance and De-identification Standards

Rendered fromprivacy-compliance.Rmdusingknitr::rmarkdownon May 17 2026.

Last update: 2026-03-18
Started: 2026-03-18

Shiny App Example: LMS Explorer

Rendered fromshiny-app.Rmdusingknitr::rmarkdownon May 17 2026.

Last update: 2026-03-06
Started: 2026-03-06

Readme and manuals

Help Manual

Help pageTopics
Build an ADS export filterbs_ads_filter
Check ADS export job statusbs_ads_job_status
Get or set the Brightspace API versionbs_api_version
Apply a PII field policy to a data framebs_apply_field_policy
Summarize assessment performance per user per quizbs_assessment_performance
Summarize assignment submission completionbs_assignment_completion
Authenticate with Brightspacebs_auth
Authenticate with a refresh tokenbs_auth_refresh
Set Brightspace authentication token directlybs_auth_token
Test Brightspace API scope accessbs_check_scopes
Convert column names from PascalCase to snake_casebs_clean_names
Read Brightspace credentials from a config filebs_config
Create or update a Brightspace config filebs_config_set
Calculate per-user per-course engagement metricsbs_course_engagement
Summarize course effectivenessbs_course_summary
Create an ADS export jobbs_create_ads_job
Clear Brightspace authenticationbs_deauth
Inspect the extract manifest from a merged BDS datasetbs_diff_manifest
Download a completed ADS exportbs_download_ads
Download all available datasetsbs_download_all
Download a dataset extractbs_download_dataset
Add a composite engagement scorebs_engagement_score
Summarize engagement by grouping dimensionbs_engagement_summary
Enrich enrollments with org unit and user detailsbs_enrich_enrollments
Filter test users from a datasetbs_filter_test_users
Get an ADS dataset by name (convenience wrapper)bs_get_ads
Get the schema for an ADS datasetbs_get_ads_schema
Get a dataset by namebs_get_dataset
Get current dataset by merging full and differential extractsbs_get_dataset_current
Get the schema for a datasetbs_get_schema
Get the current Brightspace analytics timezonebs_get_timezone
Summarize grades with percentagesbs_grade_summary
Check if authenticated with Brightspacebs_has_token
Identify at-risk studentsbs_identify_at_risk
Smart join two BDS tibblesbs_join
Join content objects with user progressbs_join_content_progress
Join enrollments with grade resultsbs_join_enrollments_grades
Join enrollments with org unitsbs_join_enrollments_orgunits
Join enrollments with role detailsbs_join_enrollments_roles
Join grade results with grade objectsbs_join_grades_objects
Join users with enrollmentsbs_join_users_enrollments
List available Advanced Data Setsbs_list_ads
List all submitted ADS export jobsbs_list_ads_jobs
List all registered ADS dataset schemasbs_list_ads_schemas
List available Brightspace Data Setsbs_list_datasets
List available extracts for a datasetbs_list_extracts
List all registered dataset schemasbs_list_schemas
Get the root organisation IDbs_org_id
Pseudonymise person-referencing ID columns in a data framebs_pseudonymise_df
Pseudonymise a vector of IDsbs_pseudonymise_id
Summarize retention and dropout ratesbs_retention_summary
Set the timezone for Brightspace analyticsbs_set_timezone
Summarize enrollments to one row per user per coursebs_summarize_enrollments