Skip to content

Commit 1782797

Browse files
committed
Update plotDrugAUCViolinPlot() documentation
1 parent 9491860 commit 1782797

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

R/drugScreening.R

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -358,9 +358,15 @@ plotDrugAUCDensityCurve <- function(drugQuantile, byGroup=FALSE) {
358358
}
359359

360360

361-
#' @title TODO
361+
#' @title Create a violin plot using the relative AUC and the sensitivity
362+
#' classes (SENSITIVE, AVERAGE, RESISTANT) of the organoids for a specific
363+
#' drug.
362364
#'
363-
#' @description The function TODO
365+
#' @description The function generates a violin plot using the relative AUC
366+
#' and the sensitivity class information present in a \code{DrugAUCQuantile}"
367+
#' object. The function uses [ggplot2::ggplot][ggplot2::ggplot()] function and
368+
#' returns a "\code{ggplot}" object. The violin tails of the violins can be
369+
#' trimmed to the range of the data.
364370
#'
365371
#' @param drugQuantile an object of class "\code{DrugAUCQuantile}" which
366372
#' contains the

man/plotDrugAUCViolinPlot.Rd

Lines changed: 8 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)