mr_report: Generate MR report

View source: R/knit.R

mr_reportR Documentation

Generate MR report

Description

Using the output from the mr() function this report will generate a report containing tables and graphs summarising the results. A separate report is produced for each exposure - outcome pair that was analysed.

Usage

mr_report(
  dat,
  output_path = ".",
  output_type = "html",
  author = "Analyst",
  study = "Two Sample MR",
  path = system.file("reports", package = "TwoSampleMR"),
  ...
)

Arguments

dat

Output from harmonise_data()

output_path

Directory in which reports should be saved.

output_type

Choose "html" or "md". Default is "html". All output files including cache and figures will appear in the folder specified in output_path.

author

Author name.

study

Study title.

path

The filepath to the report template.

...

Extra options to be passed to knitr::knit().


MRCIEU/TwoSampleMR documentation built on Sept. 28, 2024, 6:51 p.m.