Package: reportifyr 0.4.0

Jacob Dumbleton

reportifyr: Reproducible Reporting Made Simple with R

Create reproducible reports with Microsoft Word and R.

Authors:Jacob Dumbleton [aut, cre], Matthew Smith [aut], Theodoros Papathanasiou [aut], Tarjinder Sahota [aut], Devin Pastoor [aut], Agnes Kim [aut], Anne Zheng [aut], Jenna Johnson [aut], Fernando Carreno [aut], Kashyap Patel [ctb], Maxwell Chirehwa [ctb], Wesley Cummings [ctb], Elizabeth LeBeau [ctb]

reportifyr_0.4.0.tar.gz
reportifyr_0.4.0.zip(r-4.7-any)reportifyr_0.4.0.zip(r-4.6-any)reportifyr_0.4.0.zip(r-4.5-any)
reportifyr_0.4.0.tgz(r-4.6-any)reportifyr_0.4.0.tgz(r-4.5-any)
reportifyr_0.4.0.tar.gz(r-4.7-any)reportifyr_0.4.0.tar.gz(r-4.6-any)
reportifyr_0.4.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
reportifyr/json (API)

# Install 'reportifyr' in R:
install.packages('reportifyr', repos = c('https://a2-ai.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/a2-ai/reportifyr/issues

On CRAN:

Conda:

3.77 score 9 stars 22 scripts 37 exports 80 dependencies

Last updated from:6761ebe233. Checks:7 ERROR, 2 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-develERROR157
source / vignettesOK199
linux-releaseERROR152
macos-releaseERROR102
macos-oldrelERROR99
windows-develERROR99
windows-releaseERROR84
windows-oldrelERROR87
wasm-releaseOK136

Exports:add_footnotesadd_plotsadd_plots_alt_textadd_tablesadd_tables_alt_textbuild_reportfinalize_documentfind_project_rootfit_flextable_to_pageformat_flextableget_log_fileget_meta_abbrevsget_meta_typeget_venv_uv_pathsggsave_with_metadatainitialize_pythoninitialize_report_projectmake_doc_dirspreview_metadatapreview_metadata_filesremove_tables_figures_footnotesrpfy_contextsave_rds_with_metadatascript_sourceshiny_sourcesync_report_projecttoggle_loggerupdate_object_footnotesvalidate_alt_text_magic_stringsvalidate_configvalidate_docxvalidate_objectvalidate_rpfy_contextvalidate_script_sourcevalidate_shiny_sourcewrite_csv_with_metadatawrite_object_metadata

Dependencies:askpassassertthatbase64encbslibcachemclicpp11credentialscurldata.tabledigestdplyrevaluatefarverfastmapflextablefontawesomefontBitstreamVerafontLiberationfontquiverfsgdtoolsgenericsgertggplot2gluegtableherehighrhtmltoolsisobandjquerylibjsonliteknitrlabelinglifecyclelog4rmagrittrmemoisemimeofficeropensslpillarpkgconfigprocessxpspurrrpyroR6raggrappdirsRColorBrewerRcpprlangrmarkdownrprojrootrstudioapiS7sassscalesstringistringrsyssystemfontstextshapingthis.pathtibbletictoctidyrtidyselecttinytexutf8uuidvctrsviridisLitewithrxfunxml2yamlzip

Readme and manuals

Help Manual

Help pageTopics
Inserts Footnotes in appropriate places in a Microsoft Word fileadd_footnotes
Inserts Figures in appropriate places in a Microsoft Word fileadd_plots
Inserts alt text for figures within a Microsoft Word file.add_plots_alt_text
Inserts Tables in appropriate places in a Microsoft Word fileadd_tables
Inserts alt text for tables within a Microsoft Word file.add_tables_alt_text
Updates a Microsoft Word file to include formatted plots, tables, and footnotesbuild_report
Finalizes the Microsoft Word file by removing magic strings and bookmarksfinalize_document
Find the reportifyr project root directoryfind_project_root
Autofits a flextable object, then fits the object to the page widthfit_flextable_to_page
Formats data frames to a flextable specificationformat_flextable
Format a one-line summary of a reportifyr contextformat.rpfy_context
Get the current log file pathget_log_file
Get meta abbreviations from standard_footnotes.yamlget_meta_abbrevs
Get meta types from standard_footnotes.yamlget_meta_type
get_venv_uv_paths (deprecated)get_venv_uv_paths
Wrapper around the ggplot2 ggsave function. Saves a ggplot (or other grid object) and captures analysis relevant metadata in a .json fileggsave_with_metadata
Initializes python virtual environment (deprecated)initialize_python
Create report directories within a projectinitialize_report_project
Helper function that defines document output pathsmake_doc_dirs
Previews a single metadata file for an objectpreview_metadata
Preview all metadata .json files in a directorypreview_metadata_files
Print a reportifyr contextprint.rpfy_context
Removes Tables, Figures, and Footnotes from a Word fileremove_tables_figures_footnotes
reportifyr: An R package to aid in the drafting of reports.reportifyr-package reportifyr
Build a reportifyr metadata contextrpfy_context
Wrapper around the saveRDS function. Saves an object as .RDS and .RTF and captures analysis relevant metadata in a .json filesave_rds_with_metadata
Build a structured 'source' value for an artifact produced from a scriptscript_source
Build a structured 'source' value for an artifact produced from a Shiny appshiny_source
Synchronizes report project with the bundled pyro Python environment and reconciles the report 'config.yaml' against the .<report>_init.json snapshot. Always runs 'pyro::initialize_python(groups = "reportifyr")'; prompts the user only when the project '.venv' is missing, otherwise runs non-interactively (a no-op when uv reports no work needed).sync_report_project
Updates the logging level for console output. Default is set to WARN. File logging is always at DEBUG level when log_file is provided. Set 'options(rpfy.no_log = TRUE)' to suppress file logging for the session (console output is unaffected).toggle_logger
Updates an object's footnote metadata - equations, notes, or abbreviationsupdate_object_footnotes
Validate alt text of figures/tables against their magic strings in a Microsoft Word filevalidate_alt_text_magic_strings
Validate config.yaml filevalidate_config
Validates input Microsoft Word file to ensure proper functionality with reportifyrvalidate_docx
Validates a file's hash against a stored hash in the associated _metadata.json filevalidate_object
Validate a reportifyr contextvalidate_rpfy_context
Validate a 'script_source' objectvalidate_script_source
Validate a 'shiny_source' objectvalidate_shiny_source
Wrapper around the write.csv function. Saves data as .RDS and .RTF and captures analysis relevant metadata in a .json filewrite_csv_with_metadata
Writes an object's metadata .json filewrite_object_metadata