check_query: Check a query to ensure that it is suitable for analysis

In vivainsights: Analyze and Visualize Data from 'Microsoft Viva Insights'

Check a query to ensure that it is suitable for analysis

Description

Prints diagnostic data about the data query to the R console, with information such as date range, number of employees, HR attributes identified, etc.

Usage

check_query(data, return = "message", validation = FALSE)

Arguments

data	A person-level query in the form of a data frame. This includes: Standard Person Query Ways of Working Assessment Query Hourly Collaboration Query All person-level query have a PersonId column and a MetricDate column.
return	String specifying what to return. This must be one of the following strings: "message" (default) "text" See Value for more information.
validation	Logical value to specify whether to show summarized version. Defaults to FALSE. To hide checks on variable names, set validation to TRUE.

Details

This can be used with any person-level query, such as the standard person query, Ways of Working assessment query, and the hourly collaboration query. When run, this prints diagnostic data to the R console.

Value

A different output is returned depending on the value passed to the return argument:

• "message": a message is returned to the console.

• "text": string containing the diagnostic message.

See Also

Other Data Validation: extract_hr(), flag_ch_ratio(), flag_em_ratio(), flag_extreme(), flag_outlooktime(), hr_trend(), hrvar_count(), hrvar_count_all(), hrvar_trend(), identify_churn(), identify_holidayweeks(), identify_inactiveweeks(), identify_nkw(), identify_outlier(), identify_privacythreshold(), identify_shifts(), identify_tenure(), track_HR_change(), validation_report()

Examples

check_query(pq_data)

vivainsights documentation built on Aug. 8, 2025, 6:21 p.m.