diff --git a/DESCRIPTION b/DESCRIPTION index 6a14363..e27b0fa 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: FKF Title: Fast Kalman Filter -Version: 0.2.4 +Version: 0.2.5 Authors@R: c(person(given = "David", family="Luethi", role=c("aut")), person(given = "Philipp", family="Erb", role=c("aut")), person(given = "Simon", family="Otziger", role=c("aut")), @@ -31,7 +31,7 @@ Depends: R(>= 2.8) BugReports: https://github.com/waternumbers/FKF/issues URL: https://waternumbers.github.io/FKF/, https://github.com/waternumbers/FKF NeedsCompilation: yes -RoxygenNote: 7.2.1 +RoxygenNote: 7.2.3 VignetteBuilder: knitr X-CRAN-Original-Maintainer: Marc Weibel X-CRAN-Comment: Orphaned on 2018-02-11 as email address bounced when diff --git a/R/FKF-package.R b/R/FKF-package.R index b2bd88c..117b64a 100644 --- a/R/FKF-package.R +++ b/R/FKF-package.R @@ -1,12 +1,10 @@ +#' @keywords internal +"_PACKAGE" + #' @useDynLib FKF #' @import graphics -# #' @import RUnit #' @importFrom grDevices rainbow #' @importFrom stats acf ccf ppoints qchisq qnorm qqnorm qqplot #' @exportClass fkf NULL -##export("fkf", "plot.fkf") -##exportClasses("fkf") -## export plot method for class fkf -##S3method("plot", "fkf") diff --git a/man/FKF-package.Rd b/man/FKF-package.Rd new file mode 100644 index 0000000..124c1fd --- /dev/null +++ b/man/FKF-package.Rd @@ -0,0 +1,32 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/FKF-package.R +\docType{package} +\name{FKF-package} +\alias{FKF} +\alias{FKF-package} +\title{FKF: Fast Kalman Filter} +\description{ +This is a fast and flexible implementation of the Kalman filter and smoother, which can deal with NAs. It is entirely written in C and relies fully on linear algebra subroutines contained in BLAS and LAPACK. Due to the speed of the filter, the fitting of high-dimensional linear state space models to large datasets becomes possible. This package also contains a plot function for the visualization of the state vector and graphical diagnostics of the residuals. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://waternumbers.github.io/FKF/} + \item \url{https://github.com/waternumbers/FKF} + \item Report bugs at \url{https://github.com/waternumbers/FKF/issues} +} + +} +\author{ +\strong{Maintainer}: Paul Smith \email{paul@waternumbers.co.uk} (\href{https://orcid.org/0000-0002-0034-3412}{ORCID}) + +Authors: +\itemize{ + \item David Luethi + \item Philipp Erb + \item Simon Otziger + \item Daniel McDonald \email{daniel@stat.ubc.ca} +} + +} +\keyword{internal}