Skip to content

Commit de5a822

Browse files
committed
update docs
1 parent 20933da commit de5a822

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

R/computeStructuralMetrics.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#' Metrics for the assessment of post-imputation structural preservation
22
#'
3-
#' DEPRICATED. For an imputed dataset, it computes within phenotype/experimental condition similarity
3+
#' DEPRECATED. For an imputed dataset, it computes within phenotype/experimental condition similarity
44
#' (i.e. preservation of local structures), between phenotype distances
55
#' (preservation of global structures), and the Gromov-Wasserstein (GW)
66
#' distance between original (source) and imputed data.

R/msImpute.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
#' @param y Numeric matrix giving log-intensity where missing values are denoted by NA. Rows are peptides, columns are samples.
2929
#' @param method Character. Allowed values are \code{"v2"} for \code{msImputev2} imputation (enhanced version) for MAR.
3030
#' \code{method="v2-mnar"} (modified low-rank approx for MNAR), and \code{"v1"} initial release of \code{msImpute}.
31-
#' @param group Character or factor vector of length \code{ncol(y)}. DEPRICATED. Please specify the \code{design} argument.
31+
#' @param group Character or factor vector of length \code{ncol(y)}. DEPRECATED. Please specify the \code{design} argument.
3232
#' @param design Object from model.matrix(); A zero-intercept design matrix (see example).
3333
#' @param alpha Numeric. The weight parameter. Default to 0.2. Weights the MAR-imputed distribution in the imputation scheme. DEPRECATED
3434
#' @param rank.max Numeric. This restricts the rank of the solution. is set to min(dim(\code{y})-1) by default in "v1".
@@ -130,7 +130,7 @@ msImpute <- function(y, method=c("v2-mnar", "v2", "v1"),
130130
yimp <- msImputev1(y, rank.max = rank.max , lambda = estimateLambda(y, rank = rank.max)) #
131131
if (method == "v2-mnar"){
132132
message(paste("Compute barycenter of MAR and NMAR distributions", method))
133-
if (!is.null(group) & is.null(design)) stop("'group' argument is depricated. Please specify the 'design' argument.")
133+
if (!is.null(group) & is.null(design)) stop("'group' argument is deprecated. Please specify the 'design' argument.")
134134
if (is.null(group) & is.null(design)) stop("Please specify the 'design' argument. This is required for the 'v2-mnar' method.")
135135
ygauss <- gaussimpute(y, width = gauss_width, shift = gauss_shift)
136136
# yimp <- l2bary(y=y, ygauss = ygauss, yerank = yimp, group = group, a=alpha)

man/computeStructuralMetrics.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/msImpute.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)