initReportFilename,easyreporting-method {easyreporting}R Documentation

initReportFilename

Description

internal funtion usefull to init the report for the first time.

Usage

## S4 method for signature 'easyreporting'
initReportFilename(
  object,
  filenamepath = NULL,
  title = NULL,
  author = NULL,
  optionList = NULL,
  bibfile = "",
  documentType = "rmarkdown::html_document"
)

Arguments

object

an easyreporting class object

filenamepath

the name of the report with or without the path

author

the name of the report author as a person format (where expected comment named fields are ORCID, url, affiliation, affiliation_url). In case author is a character, it will be reported as it is.

bibfile

a bibfile for bibliography.

documentType

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

mainTitle

the title of the report

Value

an easyreporting class object

See Also

person


[Package easyreporting version 1.5.0 Index]