Reproducible Data Capsules with Provenance and Fallback

Documentation for package ‘rmoriebricklayer’ version 0.5.0

Help Pages

A B C D E F G H I J K L M O P R S T V W Y

-- A --

admissions	Admissions implied by a population and a length of stay
adp	Average daily population
adp_from_counts	Person-days estimated from periodic headcounts
agent_bundle	Agent-assisted reproducibility-bundle help
alos	Average length of stay
apply_schema_validation	Apply Schema Validation, Stopping on Fatal Issues
ascii_fallback	Use Text As-Is, Falling Back to ASCII When It Cannot Be Represented

-- B --

band_sensitivity	How much a result depends on the open band's assumed cap
band_values	Representative values for banded categories
benford_test	Benford first-digit test
bricklayer_fetch	Fetch a URL to disk with an Internet Archive fallback (C++/libcurl)
bricklayer_fetch_parse_siu	Fetch and parse one SIU director's report
bricklayer_fetch_siu	Fetch an Ontario SIU director's report by drid
bricklayer_json_base64url_dec	Base64 encoding
bricklayer_json_base64url_enc	Base64 encoding
bricklayer_json_base64_dec	Base64 encoding
bricklayer_json_base64_enc	Base64 encoding
bricklayer_json_from_json	Parse JSON into R objects (jsonlite's fromJSON, natively)
bricklayer_json_serialize	Lossless JSON serialisation of an R object
bricklayer_json_to_json	Encode an R object as JSON (jsonlite's toJSON, natively)
bricklayer_json_unserialize	Lossless JSON serialisation of an R object
bricklayer_parse_siu	Parse an SIU director's report into the schema fields
bricklayer_siu_iso_date	Convert a human-readable SIU report date to ISO format
bricklayer_siu_resolve_so	Resolve the subject-official count from SIU report text
bricklayer_siu_schema	The panel-reviewed SIU report field schema
bricklayer_siu_text	Convert SIU report HTML to plain text

-- C --

capsule_attest	Attest a capsule, binding a signature to what it covers
capsule_bundle	Bundle a capsule into one signed artifact
capsule_bundle_read	Bundle a capsule into one signed artifact
capsule_bundle_verify	Bundle a capsule into one signed artifact
capsule_check_attestation	Attest a capsule, binding a signature to what it covers
capsule_drift	Compare a fetched data frame with the one a capsule was pinned against
capsule_falsify	Run falsification controls against a statistic
capsule_power	Detect an injected effect of known size
capsule_report	Assess a capsule in one call
capsule_sign	Sign a capsule manifest
capsule_verify	Verify a capsule manifest signature
capture_dependencies	Where each loaded package came from
capture_environment	Capture the Analysis Environment for a Manifest
cert_chain_verify	Verify a certificate chain
cert_parse	Parse an X.509 certificate
chain_append	Tamper-evident chain of capsule manifests
chain_head	Tamper-evident chain of capsule manifests
chain_new	Tamper-evident chain of capsule manifests
chain_seal	Tamper-evident chain of capsule manifests
chain_verify	Tamper-evident chain of capsule manifests
chunk_file	Split a file into fixed-size chunks
cite_capsule	Generate a Data Citation From Provenance
clean_column_names	Tidy the column names of an ingested table
concentration	Concentration of a total across units
core_blake2b	BLAKE2b digest, optionally keyed
core_bootstrap_mean	Bootstrap replicate means (C backend)
core_cor	Fast summary statistics (C backend)
core_cor_spearman	Rank correlation and midranks (C backend)
core_cov	Covariance matrix of a numeric matrix (C backend)
core_crc32	CRC-32 checksum (C backend)
core_digest_equal	Keyed digest and constant-time comparison (C backend)
core_dist	Standard deviation and Euclidean distance (C backend)
core_gamma_cdf	Regularized incomplete gamma function (C backend)
core_hawkes_nll	Hawkes-process negative log-likelihood (C backend)
core_hmac_sha256	Keyed digest and constant-time comparison (C backend)
core_ipw_weights	Trimmed inverse-probability weights (C backend)
core_iqr	Quantiles, median and robust spread (C backend)
core_mad	Quantiles, median and robust spread (C backend)
core_mean	Fast summary statistics (C backend)
core_median	Quantiles, median and robust spread (C backend)
core_midranks	Rank correlation and midranks (C backend)
core_moments	Mean, variance, skewness and kurtosis in one pass (C backend)
core_normal_logpdf	Normal log-density (C backend)
core_normal_pdf	Normal density (C backend)
core_quantile	Quantiles, median and robust spread (C backend)
core_sd	Standard deviation and Euclidean distance (C backend)
core_sha256	SHA-256 hex digest (C backend)
core_sha512	SHA-512 hex digest (C backend)
core_trimmed_mean	Trimmed and winsorized means (C backend)
core_tukey_fences	Quantiles, median and robust spread (C backend)
core_var	Fast summary statistics (C backend)
core_weighted	Weighted mean and variance (C backend)
core_winsorized_mean	Trimmed and winsorized means (C backend)
correlation_table	Full pairwise correlation table
count_trend	Trend in a count series, as a rate ratio per period
cramers_v	Association in a contingency table
crc32_file	SHA-512 and CRC-32 of a file

-- D --

derive_key	Derive a key from a passphrase
digest_object	Digest an arbitrary R object
distinct_count	Distinct-value count in fixed memory
distinct_sketch	Distinct-value count in fixed memory
download_data	Download a File
drift_chisq	Chi-square test for a categorical column
drift_homogeneity	Chi-square test of homogeneity for two categorical samples
drift_ks	Two-sample Kolmogorov-Smirnov test (C backend)
drift_psi	Population stability index and Jensen-Shannon divergence (C backend)
drop_constant	Drop empty or constant columns and rows
drop_empty	Drop empty or constant columns and rows
duplicate_rows	Duplicated rows, with their groups

-- E --

eb_rates	Empirical Bayes rates, shrunk toward the overall experience
environment_diff	Compare two captured environments
evalue_rr	How strong would an unmeasured confounder have to be
expand_bands	Expand a banded frequency table into per-unit values
expected_counts	Expected counts under indirect standardisation

-- F --

falsify_family	Correct a family of falsification results for multiple testing
fips_key	Assemble a standardised key from raw key material
fips_keygen	Generate a standardised post-quantum signing key
fips_mu	Sign an ML-DSA message digest computed elsewhere
fips_public_key	Generate a standardised post-quantum signing key
fips_sign_mu	Sign an ML-DSA message digest computed elsewhere
fips_sizes	Byte lengths of a standardised signature scheme
fips_verify_mu	Sign an ML-DSA message digest computed elsewhere
fiscal_year_label	Name a fiscal year by the years it spans
frequency_table	Frequency table for one column
friendly_download	Download a File With Diagnostic Error Messages
funnel_limits	Funnel-plot control limits

-- G --

gini	Concentration of a total across units

-- H --

hill_tail_index	Tail index of a heavy-tailed count
hurwitz_zeta	Hurwitz zeta function

-- I --

infer_schema	Infer a pinnable schema from a data frame
inline_hist	Inline histogram for a numeric vector

-- J --

json_gzip_decode	Compressed, base64-encoded JSON
json_gzip_encode	Compressed, base64-encoded JSON

-- K --

kem_decapsulate	Recover a shared secret from an ML-KEM ciphertext
kem_encapsulate	Encapsulate a shared secret under an ML-KEM key
kem_keygen	Generate an ML-KEM key pair
kem_public_key	Generate an ML-KEM key pair
kem_sizes	Byte lengths of an ML-KEM parameter set

-- L --

load_provenance	Load a Pinned Data-Provenance Record
lorenz	Concentration of a total across units

-- M --

mahalanobis_outliers	Multivariate outliers by Mahalanobis distance
make_manifest	Construct a Reproducibility Manifest
make_synthetic_column	Generate One Synthetic Column From a Spec
make_synthetic_csv	Generate a Synthetic CSV From a Schema Recipe
manifest_canonical	The canonical serialisation of a manifest, and its digest
manifest_digest	The canonical serialisation of a manifest, and its digest
manifest_recompute	Recompute a manifest's recorded statistics against the data
manifest_record_seed	Record and restore the random number generator state
manifest_restore_seed	Record and restore the random number generator state
mcar_test	Little's test for data missing completely at random
merkle_leaves	Merkle tree over capsule chunks (C backend)
merkle_proof	Merkle tree over capsule chunks (C backend)
merkle_root	Merkle tree over capsule chunks (C backend)
merkle_verify	Merkle tree over capsule chunks (C backend)
missingness_map	Text map of where the missing values are
missingness_pattern	Which columns are missing together
missingness_summary	Missingness in one line per question
missing_runs	Runs of consecutive missing values
morans_i	Global Moran's I over a neighbour list

-- O --

online_summary	Exact summary statistics accumulated in blocks
oqs_keygen	Generate a standardised post-quantum signing key (deprecated name)
oqs_public_key	Generate a standardised post-quantum signing key (deprecated name)

-- P --

parse_bands	Parse banded category labels into numeric bounds
period_days	Period length in days, from dates
pqc_backends	Available post-quantum signature schemes
pqc_keygen	Generate a post-quantum signing key for capsule provenance
prereg_check	Declare an analysis before running it
prereg_declare	Declare an analysis before running it
print.bricklayer_attestation	Printed reports for bricklayer objects
print.bricklayer_attestation_check	Printed reports for bricklayer objects
print.bricklayer_benford	Printed reports for bricklayer objects
print.bricklayer_bundle	Printed reports for bricklayer objects
print.bricklayer_bundle_check	Printed reports for bricklayer objects
print.bricklayer_certificate	Printed reports for bricklayer objects
print.bricklayer_certpath_check	Printed reports for bricklayer objects
print.bricklayer_chain	Printed reports for bricklayer objects
print.bricklayer_drift	Printed reports for bricklayer objects
print.bricklayer_env_diff	Printed reports for bricklayer objects
print.bricklayer_falsification	Printed reports for bricklayer objects
print.bricklayer_falsify_family	Printed reports for bricklayer objects
print.bricklayer_kem_capsule	Printed reports for bricklayer objects
print.bricklayer_kem_key	Printed reports for bricklayer objects
print.bricklayer_kem_public_key	Printed reports for bricklayer objects
print.bricklayer_mcar	Printed reports for bricklayer objects
print.bricklayer_oqs_key	Printed reports for bricklayer objects
print.bricklayer_oqs_public_key	Printed reports for bricklayer objects
print.bricklayer_power	Printed reports for bricklayer objects
print.bricklayer_prereg	Printed reports for bricklayer objects
print.bricklayer_prereg_check	Printed reports for bricklayer objects
print.bricklayer_public_key	Printed reports for bricklayer objects
print.bricklayer_recompute	Printed reports for bricklayer objects
print.bricklayer_report	Printed reports for bricklayer objects
print.bricklayer_schema	Printed reports for bricklayer objects
print.bricklayer_signature	Printed reports for bricklayer objects
print.bricklayer_signing_key	Printed reports for bricklayer objects
print.bricklayer_timestamp	Printed reports for bricklayer objects
print.rmbl_band_sensitivity	How much a result depends on the open band's assumed cap
print.rmbl_yoy	Year-over-year (and period-over-period) change
profile_columns	Column report for a data frame

-- R --

random_bytes	Cryptographically strong random bytes
rate	Event rates per unit of population
rate.data.frame	Event rates per unit of population
rate.default	Event rates per unit of population
rate_change	Change in a rate between periods
rate_change.data.frame	Change in a rate between periods
record	Record a Cross-Check Result in a Manifest
region_coverage	Population of the regions that contain a unit, and of those that do not
region_map_compare	Compare a recomputed region map against a published one
region_map_from_points	Recompute a region map by point in polygon
region_map_integrity	Internal soundness of a region map
region_map_second_route	Check a region map against an independently derived assignment
report_markdown	Write a capsule report as Markdown
reservoir_indices	Uniform sample of a stream in one pass
reservoir_sample	Uniform sample of a stream in one pass
resolve_via_arcgis	Resolve a Query URL via ArcGIS FeatureServer Metadata
resolve_via_ckan	Resolve a Download URL via CKAN package_show
resolve_via_ckan_search	Resolve a Download URL via CKAN package_search
resolve_via_socrata	Resolve a Download URL via the Socrata Metadata API
revocation_fetch	Fetch revocation data for a certificate path
rmbl_base64	Base64 encoding
rmbl_chain	Tamper-evident chain of capsule manifests
rmbl_core_rank	Rank correlation and midranks (C backend)
rmbl_core_robust	Quantiles, median and robust spread (C backend)
rmbl_core_spread	Standard deviation and Euclidean distance (C backend)
rmbl_core_stats	Fast summary statistics (C backend)
rmbl_core_trimmed	Trimmed and winsorized means (C backend)
rmbl_distinct	Distinct-value count in fixed memory
rmbl_drop	Drop empty or constant columns and rows
rmbl_file_digest	SHA-512 and CRC-32 of a file
rmbl_json_gzip	Compressed, base64-encoded JSON
rmbl_json_serialize	Lossless JSON serialisation of an R object
rmbl_keyed_digest	Keyed digest and constant-time comparison (C backend)
rmbl_merkle	Merkle tree over capsule chunks (C backend)
rmbl_online	Exact summary statistics accumulated in blocks
rmbl_print_methods	Printed reports for bricklayer objects
rmbl_reservoir	Uniform sample of a stream in one pass
rmbl_rule_library	Ready-made validation rules
rule	Declare a validation rule
rule_between	Ready-made validation rules
rule_col_count	Ready-made validation rules
rule_complete_rows	Ready-made validation rules
rule_distinct_rows	Ready-made validation rules
rule_increasing	Ready-made validation rules
rule_in_set	Ready-made validation rules
rule_not_null	Ready-made validation rules
rule_regex	Ready-made validation rules
rule_unique	Ready-made validation rules
rule_within_n_mads	Ready-made validation rules

-- S --

sha256_file	Compute a File's SHA256 Digest
sha512_file	SHA-512 and CRC-32 of a file
share	Share of a total, in percent
share.data.frame	Share of a total, in percent
share.default	Share of a total, in percent
signing_public_key	Public half of a signing key
sir	Standardised incidence ratio, with an exact interval
sketch_merge	Distinct-value count in fixed memory
stay_summary	Length of stay with its distribution and interval
step_change	A single step change, with the scan's own null distribution
stock_flow	Stock and flow side by side, with the decomposition
summary.bricklayer_benford	Printed reports for bricklayer objects
summary.bricklayer_drift	Printed reports for bricklayer objects
summary.bricklayer_report	Printed reports for bricklayer objects
summary_merge	Exact summary statistics accumulated in blocks
summary_stats	Exact summary statistics accumulated in blocks
summary_update	Exact summary statistics accumulated in blocks

-- T --

timestamp_info	Verify an RFC 3161 timestamp token
timestamp_verify	Verify an RFC 3161 timestamp token
top_correlations	Strongest pairwise correlations in a data frame
top_share	Concentration of a total across units
to_ascii	Transliterate Text to Plain ASCII
trend_test	Trend in a short series

-- V --

validate_rules	Apply declared rules to a data frame
validate_schema	Validate a Data Frame Against a Provenance Schema
verify_capsule	Re-Verify an Entire Reproducible Data Capsule
verify_sha256	Verify a File's SHA256 Against an Expected Digest

-- W --

wayback_snapshot_url	Resolve a Wayback Machine snapshot URL
wayback_snapshot_url_native	Resolve a Wayback Machine snapshot URL (C++/libcurl)
write_manifest_json	Write a Manifest to JSON
write_summary_txt	Write a Plain-Language Run Summary
write_text_fallback	Write Text as UTF-8, Falling Back to ASCII on an Encoding Error

-- Y --

yoy	Year-over-year (and period-over-period) change
yoy.data.frame	Year-over-year (and period-over-period) change
yoy.integer	Year-over-year (and period-over-period) change
yoy.numeric	Year-over-year (and period-over-period) change
yoy.ts	Year-over-year (and period-over-period) change
yoy_csv	Write a change table as delimited text, JSON or Markdown
yoy_delim	Write a change table as delimited text, JSON or Markdown
yoy_html	Render a change table to HTML or PDF
yoy_json	Write a change table as delimited text, JSON or Markdown
yoy_label	Label a period without changing it
yoy_markdown	Write a change table as delimited text, JSON or Markdown
yoy_palettes	Colour palettes for change tables
yoy_pdf	Render a change table to HTML or PDF
yoy_render	Render a change table to HTML or PDF
yoy_summary	Summarise a change table
yoy_summary.rmbl_yoy	Summarise a change table
yoy_tsv	Write a change table as delimited text, JSON or Markdown
yoy_write	Write a change table to a file, in whatever format the name implies