Learn R Programming

valdr (version 2.1.0)

Access and Analyse 'VALD' Data via Our External 'APIs'

Description

Provides helper functions and wrappers to simplify authentication, data retrieval, and result processing from the 'VALD' 'APIs'. Designed to streamline integration for analysts and researchers working with 'VALD's external 'APIs'. For further documentation on integrating with 'VALD' 'APIs', see: . For a step-by-step guide to using this package, see: .

Copy Link

Version

Install

install.packages('valdr')

Monthly Downloads

12,631

Version

2.1.0

License

MIT + file LICENSE

Maintainer

Kieran Harrison

Last Published

December 12th, 2025

Functions in valdr (2.1.0)

export_forcedecks_csv

Export ForceDecks data for dashboards
.vald_default_endpoints

Build default VALD API endpoints for a region
get_forcedecks_tests_trials

Run a standard session to get new ForceDecks tests and trials only
get_forceframe_tests_only

Get only ForceFrame test data
get_forcedecks_trials

Get trial results for a set of ForceDecks tests
get_forcedecks_trials_only

Get trials for an existing test data frame
get_nordbord_tests_only

Get only NordBord test data
get_forceframe_data

Get ForceFrame test data
get_profiles_groups_categories

Get profile group and category mappings
get_access_token

Get or refresh VALD access token
get_start_date

Retrieve the start date from config
get_profiles_only

Get only VALD profiles
get_profiles_groups_categories_mapping

Get profile–group–category mappings
get_forcedecks_tests_only

Get only ForceDecks test data
get_forceframe_tests_by_id

Get a single ForceFrame test by ID
get_nordbord_data

Get NordBord test data
get_nordbord_test_by_id

Get a single NordBord test by ID
set_credentials

Set and Save VALD API Credentials
get_forceframe_test_by_id

Get a single ForceFrame test by ID
get_forceframe_tests

Get ForceFrame Tests
get_forcedecks_tests

Get ForceDecks tests
load_credentials

Load Stored VALD API Credentials and Configuration (with retry logic)
is_token_valid

Check if JWT access token is expired
get_nordbord_tests

Get NordBord Tests
set_start_date

Set and persist the start date
get_nordbord_tests_by_id

Get a single NordBord test by ID
.retry_key_get

Internal helper function to retry reading a key from the system keyring. This handles potential intermittent delays after writing to the keyring.
.onLoad

Package load hook for VALD API credentials
.build_forceframe_df

Build a ForceFrame test data frame
authenticate

Authenticate and retrieve a valid access token
.safe_extract

Safely extract a field from a list of lists
.build_nordbord_df

Build a NordBord test data frame
.build_test_attributes_long

Build long-format mapping of ForceDecks test attributes
.vald_default_export_dir

Default export directory (Downloads/VALD_Exports)
get_config

Retrieve stored VALD configuration
.get_profile_group_ids

Get profile group memberships
.safe_extract_first

Safely extract the first non-empty field from a list of lists
.validate_single_guid

Validate a single GUID test ID
.onAttach

Package attach hook for VALD API credentials
.safe_value

Safely extract a single value
.get_groups

Get groups for a tenant
.get_categories

Get categories for a tenant
get_forcedecks_data

Run full initial data fetch from the VALD ForceDecks API and External Profiles API
get_forcedecks_result_definitions

Get ForceDecks result definitions
get_forcedecks_result_definitions_only

Get only ForceDecks result definitions