RenderReportToFile {hivEstimatesAccuracy} | R Documentation

## RenderReportToFile

### Description

Creates a report from a specified RMarkdown file.

### Usage

    RenderReportToFile(
      reportFilePath,
      format = "html_fragment",
      outputFilePath = NULL,
      outDir = dirname(reportFilePath),
      ...
    )

### Arguments

`reportFilePath` | Path to the source RMarkdown file. Required.
`format` | Output format of the report. Optional. Default = `"html_fragment"`.
`outputFilePath` | Path to the output file. Optional. Default = `NULL`.
`outDir` | Output directory. Temporary directory is used if `NULL`. Optional. Default = `dirname(reportFilePath)`.
`...` | Additional arguments passed to render. Optional.

### Value

File name of the generated report

### See Also

rmarkdown

### Examples

    ## Not run:
    RenderReportToFile(
      filePath,
      params = list(AdjustedData = data.table::data.table(A = c(1, 2), B = c(3, 4))))

    ## End(Not run)

[Package hivEstimatesAccuracy version 1.10.0 Index]