Data Validation and Organization of Metadata for Local and Remote Tables

Documentation for package ‘pointblank’ version 0.12.1

Help Pages

-- A --

action_levels	Set action levels: failure thresholds and functions to invoke
activate_steps	Activate one or more of an _agent_'s validation steps
affix_date	Put the current date into a file name
affix_datetime	Put the current datetime into a file name
all_passed	Did all of the validations fully _pass_?

-- C --

col_count_match	Does the column count match that of a different table?
col_exists	Do one or more columns actually exist?
col_is_character	Do the columns contain character/string data?
col_is_date	Do the columns contain R 'Date' objects?
col_is_factor	Do the columns contain R 'factor' objects?
col_is_integer	Do the columns contain integer values?
col_is_logical	Do the columns contain logical values?
col_is_numeric	Do the columns contain numeric values?
col_is_posix	Do the columns contain 'POSIXct' dates?
col_schema	Generate a table column schema manually or with a reference table
col_schema_match	Do columns in the table (and their types) match a predefined schema?
col_vals_between	Do column data lie between two specified values or data in other columns?
col_vals_decreasing	Are column data decreasing by row?
col_vals_equal	Are column data equal to a fixed value or data in another column?
col_vals_expr	Do column data agree with a predicate expression?
col_vals_gt	Are column data greater than a fixed value or data in another column?
col_vals_gte	Are column data greater than or equal to a fixed value or data in another column?
col_vals_increasing	Are column data increasing by row?
col_vals_in_set	Are column data part of a specified set of values?
col_vals_lt	Are column data less than a fixed value or data in another column?
col_vals_lte	Are column data less than or equal to a fixed value or data in another column?
col_vals_make_set	Is a set of values entirely accounted for in a column of values?
col_vals_make_subset	Is a set of values a subset of a column of values?
col_vals_not_between	Do column data lie outside of two specified values or data in other columns?
col_vals_not_equal	Are column data not equal to a fixed value or data in another column?
col_vals_not_in_set	Are data not part of a specified set of values?
col_vals_not_null	Are column data not 'NULL'/'NA'?
col_vals_null	Are column data 'NULL'/'NA'?
col_vals_regex	Do strings in column data match a regex pattern?
col_vals_within_spec	Do values in column data fit within a specification?
conjointly	Perform multiple rowwise validations for joint validity
create_agent	Create a pointblank _agent_ object
create_informant	Create a pointblank _informant_ object
create_multiagent	Create a pointblank _multiagent_ object

-- D --

db_tbl	Get a table from a database
deactivate_steps	Deactivate one or more of an _agent_'s validation steps
draft_validation	Draft a starter pointblank validation .R/.Rmd file with a data table

-- E --

email_blast	Conditionally send email during interrogation
email_create	Create an email object from a pointblank _agent_
expect_col_count_match	Does the column count match that of a different table?
expect_col_exists	Do one or more columns actually exist?
expect_col_is_character	Do the columns contain character/string data?
expect_col_is_date	Do the columns contain R 'Date' objects?
expect_col_is_factor	Do the columns contain R 'factor' objects?
expect_col_is_integer	Do the columns contain integer values?
expect_col_is_logical	Do the columns contain logical values?
expect_col_is_numeric	Do the columns contain numeric values?
expect_col_is_posix	Do the columns contain 'POSIXct' dates?
expect_col_schema_match	Do columns in the table (and their types) match a predefined schema?
expect_col_vals_between	Do column data lie between two specified values or data in other columns?
expect_col_vals_decreasing	Are column data decreasing by row?
expect_col_vals_equal	Are column data equal to a fixed value or data in another column?
expect_col_vals_expr	Do column data agree with a predicate expression?
expect_col_vals_gt	Are column data greater than a fixed value or data in another column?
expect_col_vals_gte	Are column data greater than or equal to a fixed value or data in another column?
expect_col_vals_increasing	Are column data increasing by row?
expect_col_vals_in_set	Are column data part of a specified set of values?
expect_col_vals_lt	Are column data less than a fixed value or data in another column?
expect_col_vals_lte	Are column data less than or equal to a fixed value or data in another column?
expect_col_vals_make_set	Is a set of values entirely accounted for in a column of values?
expect_col_vals_make_subset	Is a set of values a subset of a column of values?
expect_col_vals_not_between	Do column data lie outside of two specified values or data in other columns?
expect_col_vals_not_equal	Are column data not equal to a fixed value or data in another column?
expect_col_vals_not_in_set	Are data not part of a specified set of values?
expect_col_vals_not_null	Are column data not 'NULL'/'NA'?
expect_col_vals_null	Are column data 'NULL'/'NA'?
expect_col_vals_regex	Do strings in column data match a regex pattern?
expect_col_vals_within_spec	Do values in column data fit within a specification?
expect_conjointly	Perform multiple rowwise validations for joint validity
expect_rows_complete	Are row data complete?
expect_rows_distinct	Are row data distinct?
expect_row_count_match	Does the row count match that of a different table?
expect_serially	Run several tests and a final validation in a serial manner
expect_specially	Perform a specialized validation with a user-defined function
expect_tbl_match	Does the target table match a comparison table?
export_report	Export an _agent_, _informant_, _multiagent_, or table scan to HTML

-- F --

file_tbl	Get a table from a local or remote file
from_github	Specify a file for download from GitHub

-- G --

game_revenue	A table with game revenue data
game_revenue_info	A table with metadata for the 'game_revenue' dataset
get_agent_report	Get a summary report from an agent
get_agent_x_list	Get the agent's x-list
get_data_extracts	Collect data extracts from a validation step
get_informant_report	Get a table information report from an _informant_ object
get_multiagent_report	Get a summary report using multiple agents
get_sundered_data	Sunder the data, splitting it into 'pass' and 'fail' pieces
get_tt_param	Get a parameter value from a summary table

-- H --

has_columns

Determine if one or more columns exist in a table

-- I --

incorporate	Given an _informant_ object, update and incorporate table snippets
info_columns	Add information that focuses on aspects of a data table's columns
info_columns_from_tbl	Add column information from another data table
info_section	Add information that focuses on some key aspect of the data table
info_snippet	Generate a useful text 'snippet' from the target table
info_tabular	Add information that focuses on aspects of the data table as a whole
interrogate	Given an agent that has a validation plan, perform an interrogation

-- L --

log4r_step

Enable logging of failure conditions at the validation step level

-- R --

read_disk_multiagent	Read pointblank _agents_ stored on disk as a _multiagent_
remove_steps	Remove one or more of an _agent_'s validation steps
rows_complete	Are row data complete?
rows_distinct	Are row data distinct?
row_count_match	Does the row count match that of a different table?

-- S --

scan_data	Thoroughly scan a table to better understand it
serially	Run several tests and a final validation in a serial manner
set_tbl	Set a data table to an _agent_ or an _informant_
small_table	A small table that is useful for testing
small_table_sqlite	An SQLite version of the 'small_table' dataset
snip_highest	A 'fn' for 'info_snippet()': get the highest value from a column
snip_list	A 'fn' for 'info_snippet()': get a list of column categories
snip_lowest	A 'fn' for 'info_snippet()': get the lowest value from a column
snip_stats	A 'fn' for 'info_snippet()': get an inline statistical summary
specially	Perform a specialized validation with a user-defined function
specifications	A table containing data pertaining to various specifications
stock_msg_body	Provide simple email message body components: body
stock_msg_footer	Provide simple email message body components: footer
stop_if_not	A specialized version of 'stopifnot()' for pointblank: 'stop_if_not()'
stop_on_fail	Set action levels: failure thresholds and functions to invoke

-- T --

tbl_get	Obtain a materialized table via a table store
tbl_match	Does the target table match a comparison table?
tbl_source	Obtain a table-prep formula from a table store
tbl_store	Define a store of tables with table-prep formulas: a table store
test_col_count_match	Does the column count match that of a different table?
test_col_exists	Do one or more columns actually exist?
test_col_is_character	Do the columns contain character/string data?
test_col_is_date	Do the columns contain R 'Date' objects?
test_col_is_factor	Do the columns contain R 'factor' objects?
test_col_is_integer	Do the columns contain integer values?
test_col_is_logical	Do the columns contain logical values?
test_col_is_numeric	Do the columns contain numeric values?
test_col_is_posix	Do the columns contain 'POSIXct' dates?
test_col_schema_match	Do columns in the table (and their types) match a predefined schema?
test_col_vals_between	Do column data lie between two specified values or data in other columns?
test_col_vals_decreasing	Are column data decreasing by row?
test_col_vals_equal	Are column data equal to a fixed value or data in another column?
test_col_vals_expr	Do column data agree with a predicate expression?
test_col_vals_gt	Are column data greater than a fixed value or data in another column?
test_col_vals_gte	Are column data greater than or equal to a fixed value or data in another column?
test_col_vals_increasing	Are column data increasing by row?
test_col_vals_in_set	Are column data part of a specified set of values?
test_col_vals_lt	Are column data less than a fixed value or data in another column?
test_col_vals_lte	Are column data less than or equal to a fixed value or data in another column?
test_col_vals_make_set	Is a set of values entirely accounted for in a column of values?
test_col_vals_make_subset	Is a set of values a subset of a column of values?
test_col_vals_not_between	Do column data lie outside of two specified values or data in other columns?
test_col_vals_not_equal	Are column data not equal to a fixed value or data in another column?
test_col_vals_not_in_set	Are data not part of a specified set of values?
test_col_vals_not_null	Are column data not 'NULL'/'NA'?
test_col_vals_null	Are column data 'NULL'/'NA'?
test_col_vals_regex	Do strings in column data match a regex pattern?
test_col_vals_within_spec	Do values in column data fit within a specification?
test_conjointly	Perform multiple rowwise validations for joint validity
test_rows_complete	Are row data complete?
test_rows_distinct	Are row data distinct?
test_row_count_match	Does the row count match that of a different table?
test_serially	Run several tests and a final validation in a serial manner
test_specially	Perform a specialized validation with a user-defined function
test_tbl_match	Does the target table match a comparison table?
tt_string_info	Table Transformer: obtain a summary table for string columns
tt_summary_stats	Table Transformer: obtain a summary stats table for numeric columns
tt_tbl_colnames	Table Transformer: get a table's column names
tt_tbl_dims	Table Transformer: get the dimensions of a table
tt_time_shift	Table Transformer: shift the times of a table
tt_time_slice	Table Transformer: slice a table with a slice point on a time column

-- V --

validate_rmd

Perform *pointblank* validation testing within R Markdown documents

-- W --

warn_on_fail	Set action levels: failure thresholds and functions to invoke
write_testthat_file	Transform a pointblank agent to a testthat test file

-- X --

x_read_disk	Read an _agent_, _informant_, _multiagent_, or table scan from disk
x_write_disk	Write an _agent_, _informant_, _multiagent_, or table scan to disk

-- Y --

yaml_agent_interrogate	Get an _agent_ from pointblank YAML and 'interrogate()'
yaml_agent_show_exprs	Display validation expressions using pointblank YAML
yaml_agent_string	Display pointblank YAML using an agent or a YAML file
yaml_exec	Execute all agent and informant YAML tasks
yaml_informant_incorporate	Get an _informant_ from pointblank YAML and 'incorporate()'
yaml_read_agent	Read a pointblank YAML file to create an _agent_ object
yaml_read_informant	Read a pointblank YAML file to create an _informant_ object
yaml_write	Write pointblank objects to YAML files