This vignettes will guide you throught a tipycal usage of the easyreporting package, while performing a simplified bioinformatics analysis workflow.
For the usage you just need to load the easyreporting package, which will load the rmarkdown and tools packages.
if(!requireNamespace("BiocManager", quietly = TRUE))
install.packages("BiocManager")
BiocManager::install("easyreporting")library("easyreporting")For simplicity we setup a project directory path starting from the working directory for our report, but you can just enter any path. The filenamepath and the title parameters are mandatory, while the author paramenter is optional.
Once created the easyreporting class instance, we can use it into our further code to make other operations. It stores some variables for us, in order to not be called again during next opreations. For example the name and the path of the report, the type of report and the general rmarkdown options of the document.
proj.path <- file.path(tempdir(), "bioinfo_report")
bioEr <- easyreporting(filenamePath=proj.path, title="bioinfo_report",
author=c(
person(given="Dario", family="Righelli",
email="fake_email@gmail.com",
comment=c(ORCID="ORCIDNUMBER",
url="www.fakepersonalurl.com",
affiliation="Institute of Applied Mathematics, CNR, Naples, IT",
affiliation_url="www.fakeurl.com")),
person(given="Claudia", family="Angelini",
comment=c(ORCID="ORCIDNUMBER",
url="www.fakepersonalurl.com",
affiliation="Institute of Applied Mathematics, CNR, Naples, IT",
affiliation_url="www.fakeurl.com"))
)
)#> Loading required package: distillFor this vignette we previously downloaded an xlsx table from GEO with accession number GSE134118.
For importing the xls file, we prepared an ad-hoc function called importData stored in the importFunctions.R file.
mkdTitle(bioEr, title="Loading Counts Data")
mkdCodeChunkComplete(object=bioEr, code=quote(geneCounts <- importData(
system.file("extdata/GSE134118_Table_S3.xlsx", package="easyreporting"))),
sourceFilesList=system.file("script/importFunctions.R", package="easyreporting"))#> Copying D:/biocbuild/bbs-3.13-bioc/tmpdir/RtmpsbQTol/Rinst221056fd4872/easyreporting/script/importFunctions.R to D:\biocbuild\bbs-3.13-bioc\tmpdir\RtmpwnmVGO//importFunctions.RIn order to explore the counts we can perform a PCA with plotPCA function within the EDASeq package. To trace this step we again use a mkdCodeChunkComplete function, inserting the function call as the message to track.
mkdTitle(bioEr, title="Plot PCA on count data", level=2)
mkdCodeChunkComplete(bioEr,
code=quote(EDASeq::plotPCA(as.matrix(geneCounts))))Let’s suppose we stored a function for applying edgeR on our counts in an R file. We called the file geneFunctions.R and the function applyEdgeRExample.
It will be easy for us to source the file and to call the function with a single call of easyreporting package. By aid of the mkdCodeChunkCommented function we can add a comment preceeding the code chunk.
mkdTitle(bioEr, "Differential Expression Analysis")
mkdCodeChunkCommented(bioEr,
code="degList <- applyEdgeRExample(counts=geneCounts,
samples=colnames(geneCounts), contrast='Pleura - Broth')",
comment=paste0("As we saw from the PCA, the groups are well separated",
", so we can perform a Differential Expression analysis with edgeR."),
sourceFilesList=system.file("script/geneFunctions.R",
package="easyreporting"))#> Copying D:/biocbuild/bbs-3.13-bioc/tmpdir/RtmpsbQTol/Rinst221056fd4872/easyreporting/script/geneFunctions.R to D:\biocbuild\bbs-3.13-bioc\tmpdir\RtmpwnmVGO//geneFunctions.RUsually to have a graphical representation of the obtained results we can plot an MD plot by using the plotMD function of the limma package.
Also in this case, we create a new title and a new chunk within the function to call.
mkdTitle(bioEr, "MD Plot of DEGs", level=2)
mkdCodeChunkComplete(bioEr, code="limma::plotMD(degList$test)")Once finished our analysis it is possible to compile the produced rmarkdown report simply by using the compile method. The compile method appends a sessionInfo() to the report to trace all the packages and versions used for the analysis.
compile(bioEr)sessionInfo()#> R version 4.1.0 RC (2021-05-10 r80283)
#> Platform: x86_64-w64-mingw32/x64 (64-bit)
#> Running under: Windows Server x64 (build 17763)
#>
#> Matrix products: default
#>
#> locale:
#> [1] LC_COLLATE=C
#> [2] LC_CTYPE=English_United States.1252
#> [3] LC_MONETARY=English_United States.1252
#> [4] LC_NUMERIC=C
#> [5] LC_TIME=English_United States.1252
#>
#> attached base packages:
#> [1] stats graphics grDevices utils datasets methods base
#>
#> other attached packages:
#> [1] distill_1.2 easyreporting_1.4.0 BiocStyle_2.20.0
#>
#> loaded via a namespace (and not attached):
#> [1] bookdown_0.22 digest_0.6.27 R6_2.5.0
#> [4] jsonlite_1.7.2 formatR_1.9 magrittr_2.0.1
#> [7] evaluate_0.14 stringi_1.6.2 rlang_0.4.11
#> [10] jquerylib_0.1.4 bslib_0.2.5.1 rmarkdown_2.8
#> [13] tools_4.1.0 stringr_1.4.0 xfun_0.23
#> [16] yaml_2.2.1 compiler_4.1.0 BiocManager_1.30.15
#> [19] htmltools_0.5.1.1 downlit_0.2.1 knitr_1.33
#> [22] sass_0.4.0