[Mboost-commits] r825 - in pkg/mboostPatch: . man

[noreply at r-forge.r-project.org]

Author: hofner
Date: 2015-02-12 14:57:57 +0100 (Thu, 12 Feb 2015)
New Revision: 825

Added:
   pkg/mboostPatch/man/helper.R
Modified:
   pkg/mboostPatch/NAMESPACE
Log:
export df2lambda, hyper_bbs and bl_lin to make FDboost happy

Modified: pkg/mboostPatch/NAMESPACE
===================================================================
--- pkg/mboostPatch/NAMESPACE	2015-01-17 20:03:14 UTC (rev 824)
+++ pkg/mboostPatch/NAMESPACE	2015-02-12 13:57:57 UTC (rev 825)
@@ -24,7 +24,9 @@
        bols, bspatial, brandom, btree, bss, bns, brad, bmono, bmrf, buser,
        survFit, selected, selected.mboost,
        nuisance, "%+%", "%X%", "%O%", extract, risk, "mstop<-",
-       stabsel.mboost, stabsel_parameters.mboost, confint.mboost, confint.glmboost)
+       stabsel.mboost, stabsel_parameters.mboost, confint.mboost, confint.glmboost,
+       ## exports to make FDboost happy:
+       df2lambda, hyper_bbs, bl_lin)
        ###, basesel, fitsel)
 exportClasses("boost_family")
 exportMethods("show")

Added: pkg/mboostPatch/man/helper.R
===================================================================
--- pkg/mboostPatch/man/helper.R	                        (rev 0)
+++ pkg/mboostPatch/man/helper.R	2015-02-12 13:57:57 UTC (rev 825)
@@ -0,0 +1,56 @@
+\name{helpers}
+\alias{df2lambda}
+\alias{bl_lin}
+\alias{hyper_bbs}
+
+\title{ Helper functions }
+\description{
+  These helper functions are used internally in \pkg{mboost} and are
+  exported only to allow the package \pkg{FDboost} to use them.
+}
+\usage{
+## compute Ridge shrinkage parameter lambda from df or the other way round
+df2lambda(X, df = 4, lambda = NULL, dmat = NULL, weights, XtX = NULL)
+
+## hyper parameters for P-splines baselearner (including tensor product P-splines)
+hyper_bbs(mf, vary, knots = 20, boundary.knots = NULL, degree = 3,
+          differences = 2, df = 4, lambda = NULL, center = FALSE,
+          cyclic = FALSE, constraint = "none", deriv = 0L)
+
+## workhorse for fitting (ridge-penalized) baselearners
+bl_lin(blg, Xfun, args)
+}
+\arguments{
+  \item{X}{ the design matrix. }
+  \item{df}{ degrees of freedom. See \code{\link{bbs}}. }
+  \item{lambda}{ smoothing parameter. See \code{\link{bbs}}. }
+  \item{dmat}{ penalty matrix. }
+  \item{weights}{ regression weights. }
+  \item{XtX}{ (weighted) crossproduct of the design matrix. }
+
+  \item{mf}{ model frame. }
+  \item{vary}{ names of variables that specify varying coefficients. See
+    argument \code{by} of \code{\link{bbs}}. }
+  \item{knots, boundary.knots}{ knots. See \code{\link{bbs}}. }
+  \item{degree}{ degree of the regression spline. See \code{\link{bbs}}. }
+  \item{differences}{ differences used in the penalty. See \code{\link{bbs}}. }
+  \item{center}{ use reparameterization? See \code{\link{bbs}}. }
+  \item{cyclic}{ use cyclic effects? See \code{\link{bbs}}. }
+  \item{constraint}{ type of constraint. See \code{\link{bbs}}. }
+  \item{deriv}{ See \code{\link{bbs}}. }
+
+  \item{blg}{ object of class \code{"blg"} that contains the model
+    frame, etc.}
+  \item{Xfun}{ function to set up the model matrix given the arguments
+    in \code{args}.}
+  \item{args}{ arguments. E.g. the result of a call to
+    \code{hyper_bbs}.}
+}
+\details{
+
+  Do not call these functions directly. They are only exported to make
+  the package \pkg{FDboost} happy.
+
+}
+\seealso{\code{\link{mboost}}}
+\keyword{misc}