Validation of Local and Remote Data Tables


[Up] [Top]

Documentation for package ‘pointblank’ version 0.5.2

Help Pages

A C E G I R S T V W

-- A --

action_levels Set action levels: failure thresholds and functions to invoke
agent_read Read an agent from disk
agent_write Write an agent to disk
agent_yaml_interrogate Read a YAML file to interrogate a target table immediately
agent_yaml_read Read a YAML file to create a new agent with a validation plan
agent_yaml_show_exprs Display _pointblank_ expressions using a YAML file with a validation plan
agent_yaml_string Display *pointblank* YAML using an agent or a YAML file
agent_yaml_write Write an agent's validation plan to a YAML file
all_passed Did all of the validations fully _pass_?

-- C --

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 Are column data between two specified values?
col_vals_equal Are column data equal to a specified value?
col_vals_expr Do column data agree with a predicate expression?
col_vals_gt Are column data greater than a specified value?
col_vals_gte Are column data greater than or equal to a specified value?
col_vals_in_set Are column data part of a specified set of values?
col_vals_lt Are column data less than a specified value?
col_vals_lte Are column data less than or equal to a specified value?
col_vals_not_between Are column data not between two specified values?
col_vals_not_equal Are column data not equal to a specified value?
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?
conjointly Perform multiple rowwise validations for joint validity
create_agent Create a pointblank agent object

-- E --

email_blast Send email at a step or at the end of an interrogation
email_preview Get a preview of an email before actually sending that email
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 Are column data between two specified values?
expect_col_vals_equal Are column data equal to a specified value?
expect_col_vals_expr Do column data agree with a predicate expression?
expect_col_vals_gt Are column data greater than a specified value?
expect_col_vals_gte Are column data greater than or equal to a specified value?
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 specified value?
expect_col_vals_lte Are column data less than or equal to a specified value?
expect_col_vals_not_between Are column data not between two specified values?
expect_col_vals_not_equal Are column data not equal to a specified value?
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_conjointly Perform multiple rowwise validations for joint validity
expect_rows_distinct Are row data distinct?

-- G --

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_sundered_data Sunder the data, splitting it into 'pass' and 'fail' pieces

-- I --

interrogate Given an agent that has a validation plan, perform an interrogation

-- R --

remove_read_fn Remove a table-reading function associated with an agent
remove_tbl Remove a data table associated with an agent
rows_distinct Are row data distinct?
rows_not_duplicated Verify that row data are not duplicated (deprecated)

-- S --

scan_data Thoroughly scan the table data so as to understand it better
set_read_fn Set a table-reading function to an agent
set_tbl Set a data table to an agent
small_table A small table that is useful for testing
small_table_sqlite A SQLite version of the 'small_table' dataset
stock_msg_body Provide simple email message body components: body
stock_msg_footer Provide simple email message body components: footer
stop_if_not The next generation of 'stopifnot()'-type functions: 'stop_if_not()'
stop_on_fail Set action levels: failure thresholds and functions to invoke

-- T --

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 Are column data between two specified values?
test_col_vals_equal Are column data equal to a specified value?
test_col_vals_expr Do column data agree with a predicate expression?
test_col_vals_gt Are column data greater than a specified value?
test_col_vals_gte Are column data greater than or equal to a specified value?
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 specified value?
test_col_vals_lte Are column data less than or equal to a specified value?
test_col_vals_not_between Are column data not between two specified values?
test_col_vals_not_equal Are column data not equal to a specified value?
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_conjointly Perform multiple rowwise validations for joint validity
test_rows_distinct Are row data distinct?

-- V --

validate_rmd Modify *pointblank* validation testing options within R Markdown documents

-- W --

warn_on_fail Set action levels: failure thresholds and functions to invoke