Skip to content

Commit 29b9beb

Browse files
committed
Add coef() and logLik() to summary Rd page.
1 parent 1778744 commit 29b9beb

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

R/methods.R

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@
4343
#'
4444
#' @title DFM Summary Methods
4545
#'
46-
#' @description Summary and print methods for class 'dfm'. \code{print.dfm} just prints basic model information and the factor transition matrix \eqn{\textbf{A}}{A},
47-
#' \code{summary.dfm} returns all system matrices and additional residual and goodness of fit statistics - with a print method allowing full or compact printout.
46+
#' @description Summary and print methods for class 'dfm'. \code{print.dfm} just prints basic model information and the factor transition matrix \eqn{\textbf{A}}{A}, \code{coef.dfm} returns \eqn{\textbf{A}}{A} and \eqn{\textbf{C}}{C} in a plain list, whereas
47+
#' \code{summary.dfm} returns all system matrices and additional residual and goodness of fit statistics---with a print method allowing full or compact printout.
4848
#'
4949
#' @param x,object an object class 'dfm'.
5050
#' @param digits integer. The number of digits to print out.
@@ -73,16 +73,18 @@ print.dfm <- function(x, digits = 4L, ...) {
7373
return(invisible(x))
7474
}
7575

76+
#' @rdname summary.dfm
7677
#' @export
7778
coef.dfm <- function(object, ...) list(A = object$A, C = object$C)
7879

80+
#' @rdname summary.dfm
7981
#' @export
8082
logLik.dfm <- function(object, ...) object$loglik[length(object$loglik)]
8183

8284
#' @rdname summary.dfm
8385
#' @param method character. The factor estimates to use: one of \code{"qml"}, \code{"2s"} or \code{"pca"}.
8486
#' @param \dots not used.
85-
#' @return Summary information following a dynamic factor model estimation.
87+
#' @return Summary information following a dynamic factor model estimation. \code{coef()} returns \eqn{\textbf{A}}{A} and \eqn{\textbf{C}}{C}.
8688
#' @importFrom stats cov
8789
#' @importFrom collapse pwcov
8890
#' @export

man/summary.dfm.Rd

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

0 commit comments

Comments
 (0)