How to use reporter
There are four steps to creating a report:
- Create report content
- Create report
- Add content to the report
- Write out the report
You can create the report with the create_report()
function. Content is created with the create_table(),
create_text(), or create_plot() functions. Add
content to the report with the add_content() function.
Finally, the report can be written to a file with the
write_report() function.
Let’s look at a simple example:
library(reporter)
library(magrittr)
# Create temp file name
tmp <- file.path(tempdir(), "example.pdf")
# Create report content
tbl <- create_table(mtcars) %>%
titles("MTCARS Sample Data") %>%
footnotes("* Motor Trend, 1974")
# Create report and add content
rpt <- create_report(tmp, output_type = "PDF",
font = "Courier", font_size = 12) %>%
add_content(tbl)
# Write out the report
write_report(rpt)
# Un-comment to view report
# file.show(tmp)
As you can see, using the reporter package, you can create a useful report with just a few lines of code. By default, the package creates a text report. But you can create reports in RTF, PDF, HTML, and DOCX with just a single parameter change.
Besides the functions shown above, there are additional functions to create page headers and footers, spanning headers, a report stub, a by-variable, and more. The package also allows you to add text and plots to a report. All of these capabilities are demonstrated in the examples below.