From e255bd96d4befff100b615e949ad9d7067dbc6e9 Mon Sep 17 00:00:00 2001
From: WANG Zhiwei <48282751+statwangz@users.noreply.github.com>
Date: Tue, 17 Oct 2023 21:01:06 +0800
Subject: [PATCH] Add null_check

---
 R/mfairObject.R    | 2 +-
 man/MFAIR-class.Rd | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/R/mfairObject.R b/R/mfairObject.R
index 64cc6ce..7d6e70a 100644
--- a/R/mfairObject.R
+++ b/R/mfairObject.R
@@ -19,7 +19,7 @@ setClassUnion(
 #' @slot N An integer. Number of rows (samples) of Y, also the number of rows (samples) of X.
 #' @slot M An integer. Number of columns (features) of Y.
 #' @slot C An integer. Number of columns (auxiliary covariates) of X.
-#' @slot K_max An integer. Note that increasing K_max does not ensure that the actual K also increases, since K_max is just an upper bound and the model will automatically infer K below K_max. If you want inference with larger rank K, please make sure that K_max is large enough and the tol_snr parameter in the fitting function `fitGreedy()` is small enough, simultaneously.
+#' @slot K_max An integer. Please note that increasing K_max does not ensure that the actual K also increases since K_max is just an upper bound, and the model will automatically infer K below K_max under the default setting. If you want to fit the model with larger rank K, please set the `null_check` argument as FALSE, or make sure that K_max is large enough and the `tol_snr` argument in the fitting function `fitGreedy()` is small enough simultaneously in the fitting function `fitGreedy()`.
 #' @slot K An integer. The inferred rank of Y.
 #' @slot Z An N * K matrix. Estimated loading matrix, corresponding to the inferred posterior mean of Z in the MFAI model.
 #' @slot a_sq A matrix containing posterior variance of Z with k-th column corresponding to the k-th loading. For fully observed Y, all N elements of one specific loading share the same posterior variance, then a_sq is a 1 * K matrix. For Y with missing data, elements of one specific loading have different posterior variances, then a_sq is an N * K matrix.
diff --git a/man/MFAIR-class.Rd b/man/MFAIR-class.Rd
index 2b17008..5b0c494 100644
--- a/man/MFAIR-class.Rd
+++ b/man/MFAIR-class.Rd
@@ -33,7 +33,7 @@ Each MFAIR object has a number of slots which store information. Key slots to ac
 
 \item{\code{C}}{An integer. Number of columns (auxiliary covariates) of X.}
 
-\item{\code{K_max}}{An integer. Note that increasing K_max does not ensure that the actual K also increases, since K_max is just an upper bound and the model will automatically infer K below K_max. If you want inference with larger rank K, please make sure that K_max is large enough and the tol_snr parameter in the fitting function \code{fitGreedy()} is small enough, simultaneously.}
+\item{\code{K_max}}{An integer. Please note that increasing K_max does not ensure that the actual K also increases since K_max is just an upper bound, and the model will automatically infer K below K_max under the default setting. If you want to fit the model with larger rank K, please set the \code{null_check} argument as FALSE, or make sure that K_max is large enough and the \code{tol_snr} argument in the fitting function \code{fitGreedy()} is small enough simultaneously in the fitting function \code{fitGreedy()}.}
 
 \item{\code{K}}{An integer. The inferred rank of Y.}