Skip to contents

rmarkdown_DB

Source: R/DB_summarize.R
rmarkdown_DB.Rd

Generates an RMarkdown report for the given REDCap database (`DB` object). This function creates an RMarkdown file in the specified directory or default directory, allowing users to create custom reports based on the database content.

Usage

rmarkdown_DB(DB, dir_other)

Arguments

DB

A validated `DB` object containing REDCap project data and settings. Generated using load_DB or setup_DB

dir_other

Character string specifying the directory where the RMarkdown report will be saved. If not provided, it defaults to the `output` directory inside the project's main directory.

Value

A message indicating the creation of the RMarkdown report and the path to the generated file.

Details

This function checks if a directory is specified, and if not, defaults to the `output` folder within the project's directory. It generates the RMarkdown file that can then be used for further processing or rendering into HTML, PDF, or other formats.

See also

save_DB for saving the `DB` object.

Other db_functions: summarize_DB(), transform_DB(), update_DB()