Package index • reportifyr

Set-up Functions

initialize_report_project(): Create report directories within a project

initialize_python(): Initializes python virtual environment

Analysis Output Saving Functions

ggsave_with_metadata(): Wrapper around the ggplot2 ggsave function. Saves a ggplot (or other grid object) and captures analysis relevant metadata in a .json file

save_rds_with_metadata(): Wrapper around the saveRDS function. Saves an object as .RDS and .RTF and captures analysis relevant metadata in a .json file

write_csv_with_metadata(): Wrapper around the write.csv function. Saves data as .RDS and .RTF and captures analysis relevant metadata in a .json file

format_flextable(): Formats data frames to a flextable specification

Metadata Interaction Functions

write_object_metadata(): Writes an object's metadata .json file

update_object_footnotes(): Updates an object's footnote metadata - equations, notes, or abbreviations

preview_metadata_files(): Preview all metadata .json files in a directory

preview_metadata(): Previews a single metadata file for an object

get_meta_type(): Get meta types from standard_footnotes.yaml

get_meta_abbrevs(): Get meta abbreviations from standard_footnotes.yaml

Document Interaction Functions

add_tables(): Adds tables by looking for magic string

add_footnotes(): Inserts Footnotes in appropriate places in Word files

add_plots(): Inserts Figures in appropriate places in Word files

remove_tables_figures_footnotes(): Removes Tables, Figures, and Footnotes from a Word file

Report building functions

build_report(): Updates a Word file to include formatted plots, tables, and footnotes

finalize_document(): Finalizes the document by removing magic strings and bookmarks

Utility functions

make_doc_dirs(): Helper function that defines document output paths

validate_object(): Validates a file's hash against a stored hash in the associated _metadata.json file

toggle_logger(): Updates the logging level for functions. Default is set to WARN

Reportifyr Summary

reportifyr-package reportifyr: reportifyr: An R package to aid in the drafting of reports.