easyreporting-class: easyreporting

In drighelli/easyreporting: Helps creating report for improving Reproducible Computational Research

Description

An S4 class for managing rmarkdown report. Each instance describes an rmarkdown file.

Usage

easyreporting(
  filenamePath,
  title,
  author,
  optionList = NULL,
  documentType = "rmarkdown::html_document",
  bibfile = ""
)

easyreporting(
  filenamePath,
  title,
  author,
  optionList = NULL,
  documentType = "rmarkdown::html_document",
  bibfile = ""
)

Arguments

filenamePath	the path with the name of the rmarkdown.
title	the title of the report section.
author	the author(s) of the report.
optionList	a list of options for the general rmarkdown document.
documentType	type of report final document, if author(s) is a person it will be distill::distill_article (rmarkdown::html_document default)
bibfile	a bibfile for bibliography.

Value

an S4 easyreporting class instance

Slots

filenamePath

the path with the name of the rmarkdown.

title

the title of the report section.

author

the author(s) of the report.

type

of report final document, if author(s) is a person it will be distill::distill_article (rmarkdown::html_document default)

bibfile

a bibfile for bibliography.

optionList

a list of options for the general rmarkdown document.

Examples

rd <- easyreporting(filenamePath="./project_report",
                        title="example_report", author="It's me")

drighelli/easyreporting documentation built on March 22, 2021, 9:12 p.m.