Skip to content

Commit

Permalink
Update documentation of starting_point() to avoid warnings when che…
Browse files Browse the repository at this point in the history
…cking the package.
  • Loading branch information
mahendra-mariadassou committed Nov 17, 2023
1 parent 9354485 commit 5f57160
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 3 deletions.
10 changes: 9 additions & 1 deletion R/utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -253,8 +253,16 @@ create_parameters <- function(
depths = depths)
}

#' Barebone function to compute starting points for B, M and S
#' Helper function for PLNfit initialization.
#'
#' @description
#' Barebone helper function to compute starting points for B, M and S when fitting a PLN. Intended for internal use only.
#'
#' @importFrom stats lm.fit
#' @param Y Response matrix
#' @param X Covariate matrix
#' @param O Offset matrix
#' @param w Weight vector
starting_point <- function(Y, X, O, w) {
# Y = responses, X = covariates, O = offsets (in log scale), w = weights
n <- nrow(Y); p <- ncol(Y); d <- ncol(X)
Expand Down
13 changes: 11 additions & 2 deletions man/starting_point.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 5f57160

Please sign in to comment.