Package index • brightspaceR

Authentication

Connect to your Brightspace instance via OAuth2.

bs_auth(): Authenticate with Brightspace
bs_auth_refresh(): Authenticate with a refresh token
bs_auth_token(): Set Brightspace authentication token directly
bs_deauth(): Clear Brightspace authentication
bs_has_token(): Check if authenticated with Brightspace

Datasets

Discover and download Brightspace Data Sets.

bs_list_datasets(): List available Brightspace Data Sets
bs_list_extracts(): List available extracts for a dataset
bs_download_dataset(): Download a dataset extract
bs_download_all(): Download all available datasets
bs_get_dataset(): Get a dataset by name

Joins

Convenience functions for joining related datasets.

bs_join(): Smart join two BDS tibbles
bs_join_users_enrollments(): Join users with enrollments
bs_join_enrollments_grades(): Join enrollments with grade results
bs_join_grades_objects(): Join grade results with grade objects
bs_join_content_progress(): Join content objects with user progress
bs_join_enrollments_roles(): Join enrollments with role details
bs_join_enrollments_orgunits(): Join enrollments with org units

Schemas & Parsing

Column type definitions and data cleaning.

bs_get_schema(): Get the schema for a dataset
bs_list_schemas(): List all registered dataset schemas
bs_clean_names(): Convert column names from PascalCase to snake_case

Advanced Data Sets (ADS)

Ad-hoc data exports via the Reporting API.

bs_list_ads(): List available Advanced Data Sets
bs_get_ads(): Get an ADS dataset by name (convenience wrapper)
bs_create_ads_job(): Create an ADS export job
bs_ads_job_status(): Check ADS export job status
bs_list_ads_jobs(): List all submitted ADS export jobs
bs_download_ads(): Download a completed ADS export
bs_ads_filter(): Build an ADS export filter
bs_org_id(): Get the root organisation ID
bs_get_ads_schema(): Get the schema for an ADS dataset
bs_list_ads_schemas(): List all registered ADS dataset schemas

Analytics

Composable analytics functions for engagement, performance, and retention.

bs_filter_test_users(): Filter test users from a dataset
bs_enrich_enrollments(): Enrich enrollments with org unit and user details
bs_summarize_enrollments(): Summarize enrollments to one row per user per course
bs_course_engagement(): Calculate per-user per-course engagement metrics
bs_engagement_summary(): Summarize engagement by grouping dimension
bs_engagement_score(): Add a composite engagement score
bs_grade_summary(): Summarize grades with percentages
bs_assessment_performance(): Summarize assessment performance per user per quiz
bs_assignment_completion(): Summarize assignment submission completion
bs_identify_at_risk(): Identify at-risk students
bs_retention_summary(): Summarize retention and dropout rates
bs_course_summary(): Summarize course effectiveness

Configuration

Package configuration options.

bs_api_version(): Get or set the Brightspace API version
bs_config(): Read Brightspace credentials from a config file
bs_config_set(): Create or update a Brightspace config file
bs_set_timezone(): Set the timezone for Brightspace analytics
bs_get_timezone(): Get the current Brightspace analytics timezone
bs_check_scopes(): Test Brightspace API scope access