per issue #16

Author: m-clark

LICENSE

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2020 Michael Clark
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

NAMESPACE

@@ -41,12 +41,18 @@ S3method(extract_vc,merMod)
 S3method(extract_vc,stanreg)
 export(converge_it)
 export(count_grps)
+export(extract_VarCorr)
+export(extract_coef)
 export(extract_cor_structure)
 export(extract_fixed_effects)
+export(extract_fixef)
 export(extract_het_var)
 export(extract_model_data)
+export(extract_random_coefficients)
 export(extract_random_coefs)
 export(extract_random_effects)
+export(extract_ranef)
+export(extract_variance_components)
 export(extract_vc)
 export(find_typical)
 export(summarise_model)

R/extract_fixed_effects.R

@@ -19,6 +19,9 @@
 #'   case, Only the p-value from the process is provide, all other output is
 #'   default provided `lme4` without adjustment.
 #'
+#'   `extract_fixef` is an alias.
+#'
+#'
 #' @note For `nlme`, this is just a multiplier based on the estimated standard
 #'   error and critical value for the `ci_level`.
 #'
@@ -503,3 +506,9 @@ extract_fixed_effects.gam <-
 
     fe
   }
+
+
+
+#' @rdname extract_fixed_effects
+#' @export
+extract_fixef <- extract_fixed_effects

R/extract_random_coefs.R

@@ -39,6 +39,8 @@
 #'   models.  In addition, `nlme` adds all random effects to the fixed effects,
 #'   whereas `lme4` and others only add the effects requested.
 #'
+#'   `extract_coef` and `extract_random_coefficients` are aliases.
+#'
 #' @return A data frame of the random coefficients and their standard errors.
 #'
 #' @family extract
@@ -456,3 +458,12 @@ extract_random_coefs.gam <- function(
 
   coefs
 }
+
+
+#' @rdname extract_random_coefs
+#' @export
+extract_coef <- extract_random_coefs
+
+#' @rdname extract_random_coefs
+#' @export
+extract_random_coefficients <- extract_random_coefs

R/extract_random_effects.R

@@ -43,6 +43,8 @@
 #' For mgcv, the `Vp` (Bayesian) estimated variance covariance matrix is
 #' used.
 #'
+#' `extract_ranef` is an alias.
+#'
 #' @return data frame of the random effects
 #'
 #' @seealso
@@ -696,3 +698,9 @@ extract_random_effects.gam <- function(
 
   random_effects
 }
+
+
+
+#' @rdname extract_random_effects
+#' @export
+extract_ranef <- extract_random_effects

R/extract_vc.R

@@ -26,6 +26,8 @@
 #'   for either, the relative proportion of variance, and all in a data frame
 #'   with names that are clean and easy to use.
 #'
+#'   `extract_variance_components` and `extract_VarCorr` are aliases.
+#'
 #'
 #' @note Right now, there are several issues with getting confidence intervals
 #'   for `glmmTMB` objects
@@ -680,3 +682,10 @@ extract_vc.gam <- function(
 }
 
 
+#' @rdname extract_vc
+#' @export
+extract_variance_components <- extract_vc
+
+#' @rdname extract_vc
+#' @export
+extract_VarCorr <- extract_vc

docs/ISSUE_TEMPLATE.html

@@ -0,0 +1,4 @@
+/* Styles for section anchors */
+a.anchor-section {margin-left: 10px; visibility: hidden; color: inherit;}
+a.anchor-section::before {content: '#';}
+.hasAnchor:hover a.anchor-section {visibility: visible;}