Learn R Programming

⚠️There's a newer version (0.12.1) of this package.Take me there.

Validate data in data frames, 'tibble' objects, 'Spark' 'DataFrames', and database tables (e.g., 'PostgreSQL' and 'MySQL'). Validation pipelines can be made using easily-readable, consecutive validation steps. Upon execution of the validation plan, several reporting options are available. User-defined thresholds for failure rates allow for the determination of appropriate reporting actions. Many other workflows are available including an information management workflow, where the aim is to record, collect, and generate useful information on data tables.

Copy Link

Version

Install

install.packages('pointblank')

Monthly Downloads

4,356

Version

0.7.0

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Last Published

March 9th, 2021

Functions in pointblank (0.7.0)

activate_steps

Activate one or more of an agent's validation steps
col_is_character

Do the columns contain character/string data?
affix_datetime

Put the current date-time into a file name
col_is_integer

Do the columns contain integer values?
col_is_date

Do the columns contain R Date objects?
all_passed

Did all of the validations fully pass?
affix_date

Put the current date into a file name
action_levels

Set action levels: failure thresholds and functions to invoke
col_is_factor

Do the columns contain R factor objects?
col_exists

Do one or more columns actually exist?
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_gt

Are column data greater than a fixed value or data in another column?
col_vals_expr

Do column data agree with a predicate expression?
col_vals_equal

Are column data equal to a fixed value or data in another column?
col_vals_decreasing

Are column data decreasing by row?
col_vals_lte

Are column data less than or equal to a fixed value or data in another column?
col_vals_make_subset

Is a set of values a subset of a column of values?
col_vals_make_set

Is a set of values entirely accounted for in a column of values?
col_vals_increasing

Are column data increasing by row?
col_vals_gte

Are column data greater than or equal to a fixed value or data in another column?
col_vals_lt

Are column data less than a fixed value or data in another column?
col_vals_in_set

Are column data part of a specified set 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_null

Are column data not NULL/NA?
col_vals_null

Are column data NULL/NA?
create_multiagent

Create a pointblank multiagent object
create_agent

Create a pointblank agent object
deactivate_steps

Deactivate one or more of an agent's validation steps
email_blast

Send email at a validation step or at the end of an interrogation
col_vals_not_in_set

Are data not part of a specified set of values?
get_sundered_data

Sunder the data, splitting it into 'pass' and 'fail' pieces
create_informant

Create a pointblank informant object
get_agent_x_list

Get the agent's x-list
print.action_levels

Print the action_levels object
get_data_extracts

Collect data extracts from a validation step
print.examination_page

print.ptblank_multiagent

Print the ptblank_multiagent object
has_columns

Determine if one or more columns exist in a table.
info_section

Add information that focuses on some key aspect of the data table
db_tbl

Get a table from a database
email_create

Create an email object from a pointblank agent or informant
file_tbl

Get a table from a local or remote file
incorporate

Given an informant object, update and incorporate table snippets
info_columns

Add information that focuses on aspects of a data table's columns
print.read_fn

Print the read_fn object
get_informant_report

Get a table information report from an informant object
print.ptblank_agent

Print the agent information to the console
print.ptblank_informant

Print the table information report
info_snippet

Generate a useful text 'snippet' from the target table
rows_distinct

Are row data distinct?
get_multiagent_report

Get a summary report using multiple agents
print.x_list_n

Print an x-list comprising all validation steps to the console
from_github

Specify a file for download from GitHub
conjointly

Perform multiple rowwise validations for joint validity
col_vals_regex

Do strings in column data match a regex pattern?
get_agent_report

Get a summary report from an agent
reexports

Objects exported from other packages
log4r_step

Enable logging of failure conditions at the validation step level
read_disk_multiagent

Read pointblank agents stored on disk as a multiagent
yaml_read_informant

Read a pointblank YAML file to create an informant object
%>%

Pipe operator
info_tabular

Add information that focuses on aspects of the data table as a whole
print.tbl_store

Print the tbl_store object
snip_list

A fn for info_snippet(): get a list of column categories
interrogate

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

A fn for info_snippet(): get the highest value from a column
remove_read_fn

Remove a table-prep formula associated with an agent or informant
scan_data

Thoroughly scan a table to better understand it
tbl_source

Obtain a table-prep formula from a table store
remove_steps

Remove one or more of an agent's validation steps
tbl_store

Define a store of tables with table-prep formulas: a table store
remove_tbl

Remove a data table associated with an agent or informant
validate_rmd

Modify pointblank validation testing options within R Markdown documents
stock_msg_footer

Provide simple email message body components: footer
stock_msg_body

Provide simple email message body components: body
print.x_list_i

Print a single-step x-list to the console
write_testthat_file

Transform a pointblank agent to a testthat test file
small_table

A small table that is useful for testing
yaml_write

Write pointblank objects to YAML files
yaml_agent_string

Display pointblank YAML using an agent or a YAML file
yaml_exec

Execute all agent and informant YAML tasks
x_read_disk

Read a pointblank agent or informant from disk
stop_if_not

The next generation of stopifnot()-type functions: stop_if_not()
tbl_get

Obtain a materialized table via a table store
small_table_sqlite

A SQLite version of the small_table dataset
x_write_disk

Write a pointblank agent or informant to disk
set_tbl

Set a data table to an agent or informant
snip_lowest

A fn for info_snippet(): get the lowest value from a column
set_read_fn

Set a table-prep formula to an agent or informant
snip_stats

A fn for info_snippet(): get an inline statistical summary
yaml_agent_interrogate

Get an agent from pointblank YAML and interrogate()
yaml_informant_incorporate

Get an informant from pointblank YAML and incorporate()
yaml_agent_show_exprs

Display validation expressions using pointblank YAML
yaml_read_agent

Read a pointblank YAML file to create an agent object