这些小插图将指导用户探索简易报告的功能。
对于使用，您只需要加载easyreporting包，它将加载R6而且rmarkdown包。
如果(!requireNamespace("BiocManager"， quiet = TRUE)) install.packages("BiocManager")::install("easyreporting")库(“easyreporting”)为了简单起见，我们从报告的工作目录开始设置一个项目目录路径，但是您可以直接输入任何路径。的filenamepath和标题参数为必选项，而作者(年代)参数说明可选参数。
一旦创建easyreporting类实例，我们可以在进一步的代码中使用它来进行其他操作。它为我们存储了一些变量，以便在下一次操作中不再被调用。例如，报告的名称和路径、报告的类型和文档的一般rmarkdown选项。
项目。path <- file.path(tempdir()， "general_report") er <- easyreporting(filenamePath=proj. path)path, title="example_report"， author=c(person(given="Dario"， family="Righelli"， email="fake_email@gmail.com"， comment=c(ORCID="ORCIDNUMBER"， url="www.fakepersonalurl.com"， affiliation=" CNR，那不勒斯，IT应用数学研究所"，affiliation=" www.fakeurl.com"))， person(given="Claudia"， family="Angelini"， comment=c(ORCID="ORCIDNUMBER"， url="www.fakepersonalurl.com"， affiliation=" CNR，那不勒斯，IT应用数学研究所"，association_url ="www.fakeurl.com")))) er <- easyreporting(filenamePath=proj. conf)path, title="example_report"， author=c("Dario Righelli"))Easyreporting允许包括rmarkdown标题从第一个(默认)到第六个水平．在编写报告时，好的规范总是在新的代码块(CC)中添加一个标题，后面跟着描述CC的自然语言文本。
mkdTitle(er, title="Code Chunks"， level=1) mkdGeneralMsg(er， "一个简单的段落可以用来描述我的代码块…")创建和填充CC的最机械的方法是手动打开CC，插入代码，然后关闭它。这里我们展示如何在CC中插入变量assignenent。
mkdTitle(er, title="手动代码块"，level=2)请记得关闭代码块!只要调用mkdCodeChunkEnd()一旦你完成你的函数调用:mkdVariableAssignment(er， "variable"， "variable"， show=TRUE) mkdCodeChunkEnd(er)通过使用标准函数makeOptionsList，可以创建一个自定义的选项列表optionsList)，由rmarkdown．通过这种方式，我们甚至可以根据具体情况个性化单个代码块。
这里我们创建了一个optionsList，其中includeFlag设置为真正的(默认值为假）.
当打开代码块时，可以将新的optionsList传递给easyreporting类mkdCodeChunkSt方法。
optList <- makeOptionsList(echoFlag=TRUE, includeFlag=TRUE) mkdCodeChunkSt(er, optionList=optList)请记得关闭代码块!只要调用mkdCodeChunkEnd()一旦你完成你的函数调用:mkdCodeChunkEnd (er)如果您有一个或多个文件，其中包含希望在代码中使用的某些函数，则可以使用sourceFilesList参数。
##此外，我可以在che代码块RFilesList <- list.files(system. files)中添加一个文件列表到源代码。file("script"， package="easyreporting")， full.names=TRUE) mkdCodeChunkSt(er, optionList=optList, sourceFilesList=RFilesList)#>拷贝/tmp/RtmpnJ3lPB/Rinst21c1361db0bd19/easyreporting/script/fakeFunctions。R到/tmp/RtmpHGj9SU//fakeFunctions。R#>拷贝/tmp/RtmpnJ3lPB/Rinst21c1361db0bd19/easyreporting/script/geneFunctions。R到/tmp/RtmpHGj9SU//geneFunctions。R#>拷贝/tmp/RtmpnJ3lPB/Rinst21c1361db0bd19/easyreporting/script/importFunctions。R到/tmp/RtmpHGj9SU//importFunctions。R#>拷贝/tmp/RtmpnJ3lPB/Rinst21c1361db0bd19/easyreporting/script/plotFunctions。R到/tmp/RtmpHGj9SU//plotFunctions。R请记得关闭代码块!只要调用mkdCodeChunkEnd()一旦你完成你的函数调用:mkdGeneralMsg(er, message="(v <- fakeFunction(10))") mkdCodeChunkEnd(er))属性也可以创建一个完整的块mkdCodeChunkComplete函数。
mkdCodeChunkComplete(er, code="v <- fakeFunction(11)")最后，可以在前面描述的所有功能中创建唯一的代码块。
optList <- makeOptionsList(includeFlag=TRUE, cacheFlag=TRUE) mkdCodeChunkCommented(er, comment="This is comment of the following code chunk"， code="v <- fakeFunction(12)"， optionList=optList, sourceFilesList=NULL)完成分析后，可以简单地使用编译方法。compile方法将sessionInfo()附加到报告中，以跟踪用于分析的所有包和版本。
编译(er)sessionInfo ()#> R version 4.2.0 RC (2022-04-21 r82226) #>平台:x86_64-pc-linux-gnu (64-bit) #>运行在:Ubuntu 20.04.4 LTS #> #>矩阵产品:默认#> BLAS: /home/biocbuild/bbs-3.16-bioc/R/lib/libRblas。所以#> LAPACK: /home/biocbuild/bbs-3.16-bio /R/lib/libRlapack。so #> #> locale: #> [1] LC_CTYPE=en_US。UTF-8 LC_NUMERIC= c# > [3] LC_TIME=en_GB LC_COLLATE= c# > [5] LC_MONETARY=en_US。utf - 8 LC_MESSAGES = en_US。UTF-8 #> [7] LC_PAPER=en_US。UTF-8 LC_NAME= c# > [9] LC_ADDRESS=C LC_TELEPHONE= c# > [11] LC_MEASUREMENT=en_US。UTF-8 LC_IDENTIFICATION= c# > #>附加基础包:#> [1]stats graphics grDevices utils datasets methods base #> #>其他附加包:#> [1]distill_1.3 easyreporting_1.9.0 BiocStyle_2.25.0 #> #>通过命名空间加载(且未附加):#> [1] bookdown_0.26 digest_0.6.29 R6_2.5.1 #> [4] jsonlite_1.8.0 formatR_1.12 magrittr_2.0.3 #> [7] evaluate_0.15 cachem_1.0.6 stringi_1.7.6 #> [10] rlang_1.0.2 cli_3.3.0 jquerylib_0.1.4 #> [13] bslib_0.3.1 rmarkdown_2.14 tools_4.2.0 #> [16] string_1 .4.0 xfun_0.30 yaml_2.3.5 #> [19] fastmap_1.1.0 compiler_4.2.0 BiocManager_1.30.17 #> [22] memoise_2.0.1 htmltools_0.5.2 downlit_0.4.0 #> [25] knitr_1.38 sass_0.4.1