From 365113485e85b00e28c28eeccc0e7c20f6d5b90c Mon Sep 17 00:00:00 2001 From: WANG Zhiwei <48282751+statwangz@users.noreply.github.com> Date: Mon, 2 Oct 2023 22:22:27 +0800 Subject: [PATCH] Update the documentation --- R/mfairObject.R | 2 +- man/fitBack.Rd | 2 +- man/fitGreedy.Rd | 2 +- man/matrixORdgCMatrix-class.Rd | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/R/mfairObject.R b/R/mfairObject.R index ee17fef..64cc6ce 100644 --- a/R/mfairObject.R +++ b/R/mfairObject.R @@ -1,4 +1,4 @@ -#' Define the matrixORdgCMatrix class as the union of matrix and Matrix::dgCMatrix +#' Define the matrixORdgCMatrix class as the union of matrix and Matrix::dgCMatrix. #' #' @import Matrix #' diff --git a/man/fitBack.Rd b/man/fitBack.Rd index ee07abd..be09ae4 100644 --- a/man/fitBack.Rd +++ b/man/fitBack.Rd @@ -39,7 +39,7 @@ fitBack( \item{verbose_bf_outer}{Logical. Whether to display the detailed information during the outer loop.} -\item{sf_para}{A list containing parameters for fitting the single factor MFAI model. See fitSFFully() or fitSFMissing() for details.} +\item{sf_para}{A list containing parameters for fitting the single factor MFAI model. See fitSFFully(), fitSFMissing(), or fitSFSparse() for details.} } \value{ An MFAIR object containing the information about the fitted MFAI model using backfitting algorithm. diff --git a/man/fitGreedy.Rd b/man/fitGreedy.Rd index 27ef25e..dfc67dc 100644 --- a/man/fitGreedy.Rd +++ b/man/fitGreedy.Rd @@ -39,7 +39,7 @@ fitGreedy( \item{save_init}{Logical. Whether to save the initialization of the model.} -\item{sf_para}{A list containing parameters for fitting the single factor MFAI model. See fitSFFully() or fitSFMissing() for details.} +\item{sf_para}{A list containing parameters for fitting the single factor MFAI model. See fitSFFully(), fitSFMissing(), or fitSFSparse() for details.} } \value{ An MFAIR object containing the information about the fitted MFAI model using greedy algorithm. diff --git a/man/matrixORdgCMatrix-class.Rd b/man/matrixORdgCMatrix-class.Rd index 625af45..4fd7b86 100644 --- a/man/matrixORdgCMatrix-class.Rd +++ b/man/matrixORdgCMatrix-class.Rd @@ -3,7 +3,7 @@ \docType{class} \name{matrixORdgCMatrix-class} \alias{matrixORdgCMatrix-class} -\title{Define the matrixORdgCMatrix class as the union of matrix and Matrix::dgCMatrix} +\title{Define the matrixORdgCMatrix class as the union of matrix and Matrix::dgCMatrix.} \description{ -Define the matrixORdgCMatrix class as the union of matrix and Matrix::dgCMatrix +Define the matrixORdgCMatrix class as the union of matrix and Matrix::dgCMatrix. }