pointblank0.12.1 package

Data Validation and Organization of Metadata for Local and Remote Tables

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?

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 colum...

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 anot...

col_vals_in_set

Are column data part of a specified set of values?

col_vals_increasing

Are column data increasing by row?

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...

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 co...

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

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

email_blast

Conditionally send email during interrogation

email_create

Create an email object from a pointblank agent

export_report

Export an agent, informant, multiagent, or table scan to H...

file_tbl

Get a table from a local or remote file

from_github

Specify a file for download from GitHub

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

has_columns

Determine if one or more columns exist in a table

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

log4r_step

Enable logging of failure conditions at the validation step level

pipe

Pipe operator

print.action_levels

Print the action_levels object

print.ptblank_agent

Print the ptblank_agent object

print.ptblank_informant

Print the ptblank_informant object

print.ptblank_multiagent

Print the ptblank_multiagent object

print.ptblank_multiagent_report.long

Print the ptblank_multiagent_report.long object

print.ptblank_tbl_scan

Print the ptblank_tbl_scan object

print.read_fn

Print the a table-prep formula

print.tbl_store

Print the tbl_store object

print.x_list_i

Print a single-step x-list to the console

print.x_list_n

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

read_disk_multiagent

Read pointblank agents stored on disk as a multiagent

reexports

Objects exported from other packages

remove_steps

Remove one or more of an agent's validation steps

row_count_match

Does the row count match that of a different table?

rows_complete

Are row data complete?

rows_distinct

Are row data distinct?

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

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()...

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

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

validate_rmd

Perform pointblank validation testing within R Markdown documents

write_testthat_file

Transform a pointblank agent to a testthat test file

x_read_disk

Read an agent, informant, multiagent, or table scan from d...

x_write_disk

Write an agent, informant, multiagent, or table scan to di...

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

Validate data in data frames, 'tibble' objects, 'Spark' 'DataFrames', and database tables. 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.

  • Maintainer: Richard Iannone
  • License: MIT + file LICENSE
  • Last published: 2024-03-25