Skip to contents

All functions

abbrev_num()
Abbreviate numbers for compact, uniform axis/graphic labels
align_dec()
Pad a column of formatted numbers so their decimal points align
apply_name_aliases()
Rename raw columns to their DGF variable names
apply_raw_convert_fx()
Apply DGF type-conversion functions to raw columns
as_id()
Coerce a column to an identifier (character, trimmed)
boolebar()
Draw a boolean variable as one divided bar
booleplot()
Draw a compact horizontal bar plot with consistent bar geometry
check_dgf_rules()
Check that a DGF's rules still fit the data
check_length()
Check and standardize design element length
create_all_sections()
Create sections for all variables in a DGF
create_dd()
Create a data dictionary project from a DGF
create_dgf()
create DGF file
create_dgf_skeleton()
Create an empty v2 DGF skeleton
create_div()
Create all non-level-1 div section in markdown
create_div1()
Create a level-1 div section in markdown
create_rg()
Create a research guide project from a DGF
create_section()
Create a section for a variable
datagoodr()
Generate DGF and RG
datagoodr_css()
Return the datagoodr report stylesheet
dgf_from_stable()
Rebuild a DGF from a stable CSV read
dg_baseball
Baseball players: a messy test dataset
dg_baseball_dictionary
Data dictionary for the baseball test dataset
dg_demo
Demo dataset for the datagoodr vignettes
dg_stats() dg_properties() dg_quantiles() dg_preview() dg_levels() dg_graphic() dg_field()
Render one element of a variable's profile
dg_render_type()
Pick the Research Guide template for each variable
dg_section()
Render one variable's full profile section
dollarize()
Format Numeric Values as Dollar Amounts
draft_detector_prompt()
Draft a copy-paste prompt asking an LLM to write a new type detector
draft_factor_labels_prompt()
Draft a copy-paste prompt asking an LLM to label factor levels
evaluate_detector()
Score a candidate detector against generated test cases
first_n()
Extract and Format the First N Unique Values from a Vector
get_class_df()
Summarise the class and an example value for each column
get_design()
Compile the section design for each variable type
get_dupes()
Identify and Print Duplicate Variables in a Data Frame
get_graphics()
Generate Graphics Based on Variable Type
get_json_error()
Return the parse error for an invalid JSON string
get_levels()
Return a factor's levels as a single delimited string
get_properties()
Generate Table of Properties
get_stats()
Generate Statistics Based on Variable Type
ingest_raw()
Ingest a raw dataset using DGF rules (Step 2, work in progress)
inspect_dgf()
Validate a DGF before rendering (Step 2)
is_factor()
Guess whether a vector should be treated as a factor
is_factor_df()
Guess factor columns across a data frame
jsonify_f()
Convert a factor's levels to a formatted JSON string
load_dgf()
Load DGF from DGF Excel Sheet
log_message()
Write a message to a log file (and optionally the console)
parse_design()
Parse design strings into a data frame
parse_functions()
Collect and check the conversion functions named in a DGF
parse_nm()
Split a delimited alias string into unique names
paste_boolebar()
Print a boolean variable's divided bar into the RG
paste_booleplot()
Print the bar plot of a logical variable into the RG
paste_distribution_shape()
Print the DISTRIBUTION SHAPE table (skew / kurtosis) into the RG
paste_histogram()
Print the histogram of a numeric variable into the RG
paste_label()
Print just a section label (no content) into the RG
paste_levels()
Print the level dictionary of a factor/logical variable into the RG
paste_levels_freq()
Print the combined FACTOR LEVELS table into the RG
paste_levels_horizontal()
Print the logical CATEGORY LABELS transposed across a full-width row
paste_preview_chr()
Print Preview of a Character Variable into RG
paste_preview_num()
Print Preview of a Numeric Variable into RG
paste_properties()
Print Properties of a Variable into RG
paste_properties_horizontal()
Print the PROPERTIES table transposed across one row
paste_quantiles()
Print the quantiles of a numeric variable into the RG
paste_stats_chr()
Print Statistic of a Character Variable into RG
paste_stats_chr_common()
Print the most common strings of a character variable into the RG
paste_stats_combined()
Print the combined STATS table (summary + quantiles) into the RG
paste_stats_fact()
Print Statistic of a Factor Variable into RG
paste_stats_horizontal()
Print the numeric STATS transposed across a full-width row
paste_stats_log()
Print Statistic of a Logical Variable into RG
paste_stats_num()
Print Statistic of a Numeric Variable into RG
paste_treemap()
Print Graphics of a Factor Variable into RG
preflight_dgf()
Check a dataset for degenerate columns before building a DGF
rail_contents()
Print the research guide's top bar and contents list
rail_groups()
Split a DGF into the research guide's data-type groups
rail_sections()
Print one data-type group of the research guide
read_date() read_datetime() read_yyyymmdd() read_mmddyyyy() read_ddmmyyyy() read_mdyyyy() read_dMyyyy() read_Mdyyyy() read_yyyymmddHHiiss() read_mmddyyyyhhiiA()
Read dates/datetimes written in a compact format
read_ein()
Read an EIN written in any common form
read_mm()
Read a month number written at any width
read_render_record()
Recover the render record from a rendered report
read_stable_csv()
Read a stable CSV, recovering data and embedded provenance
read_yyyy()
Read a year, plain or fiscal-year labelled
read_yyyymm()
Read a compact YYYYMM value
recast_factors()
Convert guessed factor columns to factors
rename_all()
Rename data frame columns using an alias mapping
render_record()
Record what produced this report
replace_name()
Replace variable names matching an alias
retype_dgf()
Correct a variable's type in a DGF and re-profile it
save_to_excel()
Saves DGF to excel
show_invalid()
Print the invalid JSON cells in a vector
stabilize_data()
Standardize a raw dataset with a DGF's rules
update_dgf()
Refresh a DGF against updated data (Step 4)
update_rg()
Re-render an existing report against a different DGF or dataset
use_datagoodr_template()
Copy a datagoodr report template into a project
validate_json()
Check whether each element of a vector is valid JSON
v_to_wordcloud()
Print Graphics of a character Variable into RG
wrap_preview()
Wrap preview values into a text block
write_stable_csv()
Write a data frame to a stable CSV with embedded provenance