makeReport: Generate a quality report of the screen data

In lujunyan1118/DrugScreenExplorer_dev: A pipeline for processing drug sensitivity screen data

Description

This function generates a customized Rmarkdown based html report for priliminary quality assurance.

Usage

makeReport(
  screenData,
  showCode = FALSE,
  title = "Report for my drug screening project",
  author = "Author Name",
  ifPlatePlot = FALSE
)

Arguments

screenData	a data table that contains the screen results generated by readScreen() function.
showCode	a boolean value, whether to show code in the html report.
title	a character string specifying the title for the html report
author	a character string specifying the author name
ifPlatePlot	a boolean value, whether to make plate heatmap plots in the report. Plate heatmap plots can be time consuming for large screen datasets.

Value

This function creates an html file named 'report.html' in a folder named 'report' in the working directory.

Examples

# load processed data
data(screenData_normalized)

# make html report
makeReport(screenData_normalized, showCode = TRUE,
           title = 'Report example',
           author = 'Author Name', ifPlatePlot = FALSE)

lujunyan1118/DrugScreenExplorer_dev documentation built on Dec. 21, 2021, 12:42 p.m.