report: Report

Description Usage Arguments Value

View source: R/report.R

Description

generates a report for a specific dramatic text

Usage

1
2
3
4
5
6
report(
  id = "test:rksp.0",
  of = file.path(getwd(), paste0(unlist(strsplit(id, ":", fixed = TRUE))[2], ".html")),
  type = c("Single", "Compare"),
  ...
)

Arguments

id

The id of the text or a list of ids

of

The output file

type

The type of the report. "Single" gives a report about a single play, while "Compare" can be used to compare multiple editions of a play. Please note that the "Compare" report is still under development.

...

Arguments passed through to the rmarkdown document

Value

The return value of render


DramaAnalysis documentation built on Jan. 13, 2021, 10:02 p.m.