diff --git a/DESCRIPTION b/DESCRIPTION index 1dd61a4e..bc3446ad 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -31,7 +31,6 @@ Imports: magrittr, rlang, stats, - statmod, stringr, tidyr, utils diff --git a/R/cdfPlot.R b/R/cdfPlot.R index 0464a3e9..740962c3 100644 --- a/R/cdfPlot.R +++ b/R/cdfPlot.R @@ -14,7 +14,7 @@ #' #' @param dgeObj A DGEobj with one or more topTables #' @param contrast Name of a topTable dataframe with p-value or an FDR column -#' @param plotType Plot type must be canvasXpress or ggplot (default = canvasXpress). +#' @param plotType Plot type must be canvasXpress or ggplot (default = canvasXpress) #' @param pvalCol Name of the p-value or FDR column (default = "P.Value") #' @param pvalMax Limit the range of the main plot (default = 0.10) #' @param pThreshold Significant value threshold (default = 0.01) diff --git a/R/ggplotMDS.R b/R/ggplotMDS.R index a24d677a..a0a17be5 100644 --- a/R/ggplotMDS.R +++ b/R/ggplotMDS.R @@ -23,8 +23,8 @@ #' @param labels A column name in the design table. Text labels for the samples. These should be short #' abbreviations of the sample identifiers. #' Default = ReplicateGroup or rownames of dgeObj. Set to NULL to disable -#' text labels. -#' @param title A title for the plot. (Optional) +#' text labels +#' @param title A title for the plot (Optional) #' @param xlab x axis label (Optional) #' @param ylab y axis label (Optional) #' @param vlineIntercept X intercept of vertical line (Optional) diff --git a/R/logRatioPlot.R b/R/logRatioPlot.R index 26f02f6b..09ece8ef 100644 --- a/R/logRatioPlot.R +++ b/R/logRatioPlot.R @@ -14,9 +14,9 @@ #' ggplots, one for each facetColname value \emph{(typically gene)}. #' #' @param dgeObj A DGEobj that contains topTable objects -#' @param plotType Plot type must be canvasXpress or ggplot (default to canvasXpress). -#' @param facetColname Column name to separate plots from geneData (default = "rgd_symbol"). -#' @param xColname The computed column to group boxplots by (default = "Contrast"). +#' @param plotType Plot type must be canvasXpress or ggplot (default to canvasXpress) +#' @param facetColname Column name to separate plots from geneData (default = "rgd_symbol") +#' @param xColname The computed column to group boxplots by (default = "Contrast") #' @param yColname Column name for the output of the boxplots (default = "logFC") #' @param CI.R_colname Name of the CI high value (default = "CI.R") #' @param CI.L_colname Name of the CI low value (default = "CI.L") diff --git a/R/mapDGEobj.R b/R/mapDGEobj.R index e93fe886..0efd0126 100644 --- a/R/mapDGEobj.R +++ b/R/mapDGEobj.R @@ -3,12 +3,12 @@ #' Reads a DGEobj and visualizes parent/child relationships between #' data items in a DGEobj. #' -#' @param dgeObj DGEobj to find the parent/child relationships between data items. -#' @param plotType Must be canvasXpress or ggplot (default = canvasXpress). +#' @param dgeObj DGEobj to find the parent/child relationships between data items +#' @param plotType Must be canvasXpress or ggplot (default = canvasXpress) #' @param directed Only applies to ggplot. Indicates if the graph should -#' be directed or not. (default = TRUE) +#' be directed or not (default = TRUE) #' -#' @return A class ggplot object or a canvasXpress network plot. +#' @return A class ggplot object or a canvasXpress network plot #' #' #' @examples diff --git a/R/obsPlot.R b/R/obsPlot.R index a9a8e08e..12fc39e1 100644 --- a/R/obsPlot.R +++ b/R/obsPlot.R @@ -13,15 +13,15 @@ #' #' @param dgeObj A DGEObject. The countsMatrix in the DGEObject is extracted to plot the data. (required) #' @param plotType Can be canvasXpress or ggplot (default = canvasXpress) -#' @param designTable Name of the design table in the DGEObj from which the grouping column will be extracted. (default = design) -#' @param countsMatrix Name of the counts matrix in the DGEObj which will be used to render the plot.(default = counts) +#' @param designTable Name of the design table in the DGEObj from which the grouping column will be extracted (default = design) +#' @param countsMatrix Name of the counts matrix in the DGEObj which will be used to render the plot (default = counts) #' @param convertCounts A flag to indicate if counts matrix need to be converted or taken as is. Default value is NULL. This indicates -#' countsMatrix need to be taken as is. To convert the counts matrix, specify the desired unit. Supported units include CPM,FPKM, FPK and TPM. +#' countsMatrix need to be taken as is. To convert the counts matrix, specify the desired unit. Supported units include CPM, FPKM, FPK and TPM. #' This parameter is passed to DGEobj.utils::convertCounts (default = NULL) -#' @param convert_geneLength Parameter to pass to DGEobj.utils::convertCounts. (optional). -#' @param convert_log Parameter to pass to DGEobj.utils::convertCounts. (default = FALSE) -#' @param convert_normalize Parameter to pass to DGEobj.utils::convertCounts. (default = none) -#' @param convert_prior.count Parameter to pass to DGEobj.utils::convertCounts. (default = NULL) +#' @param convert_geneLength Parameter to pass to DGEobj.utils::convertCounts (optional) +#' @param convert_log Parameter to pass to DGEobj.utils::convertCounts (default = FALSE) +#' @param convert_normalize Parameter to pass to DGEobj.utils::convertCounts (default = none) +#' @param convert_prior.count Parameter to pass to DGEobj.utils::convertCounts (default = NULL) #' @seealso \link[DGEobj.utils]{convertCounts} #' @param group Define the column name to group boxplots by (typically a replicate group column) (required) #' @param violinLayer Adds a violin layer (default = FALSE) @@ -29,8 +29,8 @@ #' @param xlab X axis label (defaults to group column name if not specified) #' @param ylab Y axis label (defaults to value column name if not specified) #' @param title Plot title (optional) -#' @param facet Specifies whether to facet (TRUE) or print individual plots -#' (FALSE) (default = TRUE). It is recommended to facet no more than 40 plots. If 40 of more plots are needed, please set this argument to FALSE +#' @param facet Specifies whether to facet (TRUE, default) or print individual plots +#' (FALSE). It is recommended to facet no more than 40 plots. If 40 of more plots are needed, please set this argument to FALSE #' @param axisFree Specify same scale or independent scales for each subplot (default = TRUE; #' Allowed values: TRUE or FALSE) #' diff --git a/R/plotDispersion.R b/R/plotDispersion.R index f7fa1171..fb025d9c 100644 --- a/R/plotDispersion.R +++ b/R/plotDispersion.R @@ -7,8 +7,8 @@ #' #' @param dgeObj DGEobj which has a counts matrix or a DGElist #' @param replicateGroupCol A singular value of class character and must be a column name in design object (default = "ReplicateGroup") -#' @param countsMatrix If TRUE, uses the countsMatrix in DGEobj to construct the plot else DGElist will be used. (default = TRUE) -#' @param plotType Plot type must be canvasXpress or ggplot (default = canvasXpress). +#' @param countsMatrix If TRUE, uses the countsMatrix in DGEobj to construct the plot else DGElist will be used (default = TRUE) +#' @param plotType Plot type must be canvasXpress or ggplot (default = canvasXpress) #' @param plotCategory One of "dispersion" or "BCV" (default = "dispersion") #' @param lineFit If the plotType is ggplot, any method supported by `geom_smooth()`. If the plotType is canvasXpress, one of glm, lm, loess, gam is accepted . #' Loess is recommended. (default = NULL) diff --git a/R/plotNorm.R b/R/plotNorm.R index 0821ed7a..14170543 100644 --- a/R/plotNorm.R +++ b/R/plotNorm.R @@ -10,7 +10,7 @@ #' #' @param dgeObj DGEobj with a counts Matrix #' @param plotType Plot type must be canvasXpress or ggplot (defaults to canvasXpress). -#' @param plotCategory Show a "box" or "density" plot (default = "box") +#' @param plotCategory Show a "box" or "density" plot (default = "box"). #' @param normalize The type of normalization to use (default = "TMM"). Other allowed #' values are: "RLE", "upperquartile" and "none". Invokes edgeR::calcNormFactors for #' normalization. diff --git a/man/cdfPlot.Rd b/man/cdfPlot.Rd index 33a0c8be..993f469a 100644 --- a/man/cdfPlot.Rd +++ b/man/cdfPlot.Rd @@ -26,7 +26,7 @@ cdfPlot( \item{contrast}{Name of a topTable dataframe with p-value or an FDR column} -\item{plotType}{Plot type must be canvasXpress or ggplot (default = canvasXpress).} +\item{plotType}{Plot type must be canvasXpress or ggplot (default = canvasXpress)} \item{pvalCol}{Name of the p-value or FDR column (default = "P.Value")} diff --git a/man/ggplotMDS.Rd b/man/ggplotMDS.Rd index 03d30a7f..2e52fa53 100644 --- a/man/ggplotMDS.Rd +++ b/man/ggplotMDS.Rd @@ -38,9 +38,9 @@ ggplotMDS( \item{labels}{A column name in the design table. Text labels for the samples. These should be short abbreviations of the sample identifiers. Default = ReplicateGroup or rownames of dgeObj. Set to NULL to disable -text labels.} +text labels} -\item{title}{A title for the plot. (Optional)} +\item{title}{A title for the plot (Optional)} \item{xlab}{x axis label (Optional)} diff --git a/man/logRatioPlot.Rd b/man/logRatioPlot.Rd index 9df246f3..6b981363 100644 --- a/man/logRatioPlot.Rd +++ b/man/logRatioPlot.Rd @@ -25,11 +25,11 @@ logRatioPlot( \arguments{ \item{dgeObj}{A DGEobj that contains topTable objects} -\item{plotType}{Plot type must be canvasXpress or ggplot (default to canvasXpress).} +\item{plotType}{Plot type must be canvasXpress or ggplot (default to canvasXpress)} -\item{facetColname}{Column name to separate plots from geneData (default = "rgd_symbol").} +\item{facetColname}{Column name to separate plots from geneData (default = "rgd_symbol")} -\item{xColname}{The computed column to group boxplots by (default = "Contrast").} +\item{xColname}{The computed column to group boxplots by (default = "Contrast")} \item{yColname}{Column name for the output of the boxplots (default = "logFC")} diff --git a/man/mapDGEobj.Rd b/man/mapDGEobj.Rd index e3de2373..87bf4c44 100644 --- a/man/mapDGEobj.Rd +++ b/man/mapDGEobj.Rd @@ -7,15 +7,15 @@ mapDGEobj(dgeObj, plotType = "canvasXpress", directed = TRUE) } \arguments{ -\item{dgeObj}{DGEobj to find the parent/child relationships between data items.} +\item{dgeObj}{DGEobj to find the parent/child relationships between data items} -\item{plotType}{Must be canvasXpress or ggplot (default = canvasXpress).} +\item{plotType}{Must be canvasXpress or ggplot (default = canvasXpress)} \item{directed}{Only applies to ggplot. Indicates if the graph should -be directed or not. (default = TRUE)} +be directed or not (default = TRUE)} } \value{ -A class ggplot object or a canvasXpress network plot. +A class ggplot object or a canvasXpress network plot } \description{ Reads a DGEobj and visualizes parent/child relationships between diff --git a/man/obsPlot.Rd b/man/obsPlot.Rd index 6cf9728d..e0e04b37 100644 --- a/man/obsPlot.Rd +++ b/man/obsPlot.Rd @@ -29,21 +29,21 @@ obsPlot( \item{plotType}{Can be canvasXpress or ggplot (default = canvasXpress)} -\item{countsMatrix}{Name of the counts matrix in the DGEObj which will be used to render the plot.(default = counts)} +\item{countsMatrix}{Name of the counts matrix in the DGEObj which will be used to render the plot (default = counts)} \item{convertCounts}{A flag to indicate if counts matrix need to be converted or taken as is. Default value is NULL. This indicates -countsMatrix need to be taken as is. To convert the counts matrix, specify the desired unit. Supported units include CPM,FPKM, FPK and TPM. +countsMatrix need to be taken as is. To convert the counts matrix, specify the desired unit. Supported units include CPM, FPKM, FPK and TPM. This parameter is passed to DGEobj.utils::convertCounts (default = NULL)} -\item{convert_geneLength}{Parameter to pass to DGEobj.utils::convertCounts. (optional).} +\item{convert_geneLength}{Parameter to pass to DGEobj.utils::convertCounts (optional)} -\item{convert_log}{Parameter to pass to DGEobj.utils::convertCounts. (default = FALSE)} +\item{convert_log}{Parameter to pass to DGEobj.utils::convertCounts (default = FALSE)} -\item{convert_normalize}{Parameter to pass to DGEobj.utils::convertCounts. (default = none)} +\item{convert_normalize}{Parameter to pass to DGEobj.utils::convertCounts (default = none)} -\item{convert_prior.count}{Parameter to pass to DGEobj.utils::convertCounts. (default = NULL)} +\item{convert_prior.count}{Parameter to pass to DGEobj.utils::convertCounts (default = NULL)} -\item{designTable}{Name of the design table in the DGEObj from which the grouping column will be extracted. (default = design)} +\item{designTable}{Name of the design table in the DGEObj from which the grouping column will be extracted (default = design)} \item{group}{Define the column name to group boxplots by (typically a replicate group column) (required)} @@ -57,8 +57,8 @@ This parameter is passed to DGEobj.utils::convertCounts (default = NULL)} \item{title}{Plot title (optional)} -\item{facet}{Specifies whether to facet (TRUE) or print individual plots -(FALSE) (default = TRUE). It is recommended to facet no more than 40 plots. If 40 of more plots are needed, please set this argument to FALSE} +\item{facet}{Specifies whether to facet (TRUE, default) or print individual plots +(FALSE). It is recommended to facet no more than 40 plots. If 40 of more plots are needed, please set this argument to FALSE} \item{axisFree}{Specify same scale or independent scales for each subplot (default = TRUE; Allowed values: TRUE or FALSE)} diff --git a/man/plotDispersion.Rd b/man/plotDispersion.Rd index 47eb6cda..532e953f 100644 --- a/man/plotDispersion.Rd +++ b/man/plotDispersion.Rd @@ -17,11 +17,11 @@ plotDispersion( \arguments{ \item{dgeObj}{DGEobj which has a counts matrix or a DGElist} -\item{countsMatrix}{If TRUE, uses the countsMatrix in DGEobj to construct the plot else DGElist will be used. (default = TRUE)} +\item{countsMatrix}{If TRUE, uses the countsMatrix in DGEobj to construct the plot else DGElist will be used (default = TRUE)} \item{replicateGroupCol}{A singular value of class character and must be a column name in design object (default = "ReplicateGroup")} -\item{plotType}{Plot type must be canvasXpress or ggplot (default = canvasXpress).} +\item{plotType}{Plot type must be canvasXpress or ggplot (default = canvasXpress)} \item{plotCategory}{One of "dispersion" or "BCV" (default = "dispersion")} diff --git a/man/plotNorm.Rd b/man/plotNorm.Rd index de7af387..54bd5137 100644 --- a/man/plotNorm.Rd +++ b/man/plotNorm.Rd @@ -16,7 +16,7 @@ plotNorm( \item{plotType}{Plot type must be canvasXpress or ggplot (defaults to canvasXpress).} -\item{plotCategory}{Show a "box" or "density" plot (default = "box")} +\item{plotCategory}{Show a "box" or "density" plot (default = "box").} \item{normalize}{The type of normalization to use (default = "TMM"). Other allowed values are: "RLE", "upperquartile" and "none". Invokes edgeR::calcNormFactors for