wpa (version 1.4.3)

check_query: 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 Date 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 return a check used by the validation_report(). Defaults to FALSE. To hide checks on variable names, set validation to TRUE.

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.

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.

See Also

Other Data Validation: extract_hr(), flag_ch_ratio(), flag_em_ratio(), flag_extreme(), flag_outlooktime(), hr_trend(), hrvar_count_all(), hrvar_count(), identify_churn(), identify_holidayweeks(), identify_inactiveweeks(), identify_nkw(), identify_outlier(), identify_privacythreshold(), identify_query(), identify_shifts_wp(), identify_shifts(), identify_tenure(), remove_outliers(), standardise_pq(), subject_validate_report(), subject_validate(), track_HR_change(), validation_report()

Examples

# NOT RUN {
check_query(sq_data)

# }