# Validation of Local and Remote Data Tables

## Documentation for package ‘pointblank’ version 0.7.0

- DESCRIPTION file.

## Help Pages

A C D E F G H I L R S T V W X Y

## -- 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 date-time into a file name
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 | 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?
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

## -- E --

email_blast | Send email at a validation step or at the end of an interrogation
email_create | Create an email object from a *pointblank* _agent_ or _informant_
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_conjointly | Perform multiple rowwise validations for joint validity
expect_rows_distinct | Are row data distinct?

## -- F --

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

## -- 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_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

## -- 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_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_read_fn | Remove a table-prep formula associated with an _agent_ or _informant_
remove_steps | Remove one or more of an _agent_'s validation steps
remove_tbl | Remove a data table associated with an _agent_ or _informant_
rows_distinct | Are row data distinct?

## -- S --

scan_data | Thoroughly scan a table to better understand it
set_read_fn | Set a table-prep formula to an _agent_ or _informant_
set_tbl | Set a data table to an _agent_ or _informant_
small_table | A small table that is useful for testing
small_table_sqlite | A 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
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 --

tbl_get | Obtain a materialized table via a table store
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_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_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
write_testthat_file | Transform a *pointblank* agent to a *testthat* test file

## -- X --

x_read_disk | Read a *pointblank* _agent_ or _informant_ from disk
x_write_disk | Write a *pointblank* _agent_ or _informant_ 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