Skip to content

Commit 50fce96

Browse files
committed
Add Details, Value and Examples sections to avoid "Warning: missing </ul> before </div>" CRAN check warning on r-devel Debian
1 parent 5af2604 commit 50fce96

5 files changed

Lines changed: 42 additions & 4 deletions

File tree

R/alogLik_methods.R

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
#'
66
#' @param object A fitted model object.
77
#' @param ... Further arguments.
8+
#' @details See \code{\link{alogLik}}: loglikelihood adjustment for model fits.
9+
#' @return An object of class \code{"logLikVec"}, a vector containing
10+
#' individual loglikelihood contributions.
11+
#' @section Examples:
12+
#' See the example in \code{\link{bernoulli}}.
813
#' @export
914
logLikVec <- function(object, ...) {
1015
UseMethod("logLikVec")
@@ -209,6 +214,13 @@ alogLik.default <- function(x, cluster = NULL, use_vcov = TRUE, binom = FALSE,
209214
#' @param object An object of class \code{"logLikVec"} return from a
210215
#' \code{logLikVec} method.
211216
#' @param ... Further arguments.
217+
#' @details See \code{\link{alogLik}}: loglikelihood adjustment for model fits.
218+
#' @return An object of class \code{"logLik"}. This is the value of the
219+
#' loglikelihood, with attributes \code{"df"} (degrees of freedom) giving
220+
#' the number of free parameters, and \code{"nobs"} giving the number of
221+
#' observations.
222+
#' @section Examples:
223+
#' See the example in \code{\link{bernoulli}}.
212224
#' @export
213225
logLik.logLikVec <- function(object, ...) {
214226
save_attributes <- attributes(object)

R/bernoulli.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@
3838
#' \code{\link[stats:na.fail]{na.omit}}.
3939
#'
4040
#' \code{logLikVec.bernoulli} returns an object of class \code{"logLikVec"}, a
41-
#' vector length \code{length(data)} containing the likelihood contributions
42-
#' from the individual observations in \code{data}.
41+
#' vector of length \code{length(data)} containing the loglikelihood
42+
#' contributions from the individual observations in \code{data}.
4343
#' @seealso \code{\link[stats]{Binomial}}. The Bernoulli distribution is the
4444
#' special case where \code{size = 1}.
4545
#' @examples

man/bernoulli.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/logLik.logLikVec.Rd

Lines changed: 14 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/logLikVec.Rd

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)