Skip to content

Commit

Permalink
Set basic structure for all functions
Browse files Browse the repository at this point in the history
  • Loading branch information
courtiol committed Mar 6, 2021
1 parent 70fd218 commit 395e65d
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 0 deletions.
3 changes: 3 additions & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Generated by roxygen2: do not edit by hand

S3method(augment,HLfit)
S3method(augment,brmsfit)
S3method(augment,gamm4)
S3method(augment,glmmTMB)
Expand All @@ -9,6 +10,7 @@ S3method(augment,lme)
S3method(augment,merMod)
S3method(augment,ranef.mer)
S3method(fixef,MCMCglmm)
S3method(glance,HLfit)
S3method(glance,brmsfit)
S3method(glance,gamlss)
S3method(glance,gamm4)
Expand All @@ -20,6 +22,7 @@ S3method(glance,merMod)
S3method(glance,stanreg)
S3method(ranef,MCMCglmm)
S3method(sigma,brmsfit)
S3method(tidy,HLfit)
S3method(tidy,MCMCglmm)
S3method(tidy,MixMod)
S3method(tidy,TMB)
Expand Down
42 changes: 42 additions & 0 deletions R/spaMM_tidiers.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
#' Tidying methods for mixed effects models
#'
#' These methods tidy the coefficients of mixed effects models, particularly
#' responses of the \code{HLfit} class
#'
#' @inheritParams glmmTMB_tidiers
#' @param x An object of class \code{HLfit}, such as those from \code{fitme},
#' \code{HLfit}, or \code{corrHLfit}
#'
#' @return All tidying methods return a \code{tibble}.
#' The structure depends on the method chosen.
#'
#' @name spaMM_tidiers
#' @aliases tidy.HLfit
#'
#' @examples
#'
#' if (require("spaMM") && require("lme4")) {
#' lmm1 <- lmer(Reaction ~ Days + (Days | Subject), sleepstudy)
#' tidy(lmm1)
#' augment(lmm1)
#' glance(lmm1)
#' }
NULL

#' @rdname spaMM_tidiers
#' @export
tidy.HLfit <- function(x, effects = c("ran_pars", "fixed"), ...) {
message("method not yet implemented")
}

#' @rdname spaMM_tidiers
#' @export
augment.HLfit <- function(x, ...) {
message("method not yet implemented")
}

#' @rdname spaMM_tidiers
#' @export
glance.HLfit <- function(x, ...) {
message("method not yet implemented")
}
40 changes: 40 additions & 0 deletions man/spaMM_tidiers.Rd

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

0 comments on commit 395e65d

Please sign in to comment.