Documentation

R/acd.R

@@ -27,7 +27,7 @@
 #' 
 #' @param x a numeric vector.
 #' @param powers a vector of allowed FP powers. The default value is `NULL`,
-#' meaning that the set S = {(-2, -1, -0.5, 0, 0.5, 1, 2, 3)} is used.
+#' meaning that the set \eqn{S = (-2, -1, -0.5, 0, 0.5, 1, 2, 3)} is used.
 #' @param shift a numeric that is used to shift the values of `x` to positive
 #' values. The default value is 0, meaning no shifting is conducted. 
 #' If `NULL`, then the program will estimate an appropriate shift automatically

R/generation_powers.R

@@ -6,7 +6,7 @@
 #' triples of powers, and so on. If the ACD transformation is used,
 #' this degree is assumed to be 2.
 #' @param powers the set of allowed powers for the fractional polynomials. 
-#' Default is `NULL` and the set {-2, -1, -0.5, 0, 0.5, 1, 2, 3} is used.
+#' Default is `NULL` and the set \eqn{(-2, -1, -0.5, 0, 0.5, 1, 2, 3)} is used.
 #' 
 #' @details 
 #' For FP powers, this function returns all combinations of the powers of 

R/mfp2.R

@@ -378,22 +378,22 @@
 #' An object of class `mfp2` is a list containing all entries as for `glm`
 #' or `coxph`, and in addition the following entries:  
 #' \itemize{
-#' \item{convergence_mfp: }{logical value indicating convergence of mfp algorithm.}
-#' \item{fp_terms: }{a data.frame with information on fractional polynomial 
+#' \item{"convergence_mfp:" }{logical value indicating convergence of mfp algorithm.}
+#' \item{"fp_terms: "}{a data.frame with information on fractional polynomial 
 #' terms.}
-#' \item{transformations: }{a data.frame with information on shifting, scaling
+#' \item{"transformations: "}{a data.frame with information on shifting, scaling
 #' and centering for all variables.}   
-#' \item{fp_powers: }{a list with all powers of fractional polynomial terms. 
+#' \item{"fp_powers: "}{a list with all powers of fractional polynomial terms. 
 #' Each entry of the list is named according to the transformation of the 
 #' variable.}
-#' \item{acd: }{a vector with information for which variables the acd 
+#' \item{"acd: "}{a vector with information for which variables the acd 
 #' transformation was applied.}
-#' \item{x_original: }{the scaled and shifted input matrix but without
+#' \item{"x_original: "}{the scaled and shifted input matrix but without
 #' transformations.}
-#' \item{y: }{the original outcome variable.}
-#' \item{x: }{the final transformed input matrix used to fit the final model.}
-#' \item{call_mfp: }{the call to the `mfp2()` function.}
-#' \item{family_string: }{the family stored as character string.}
+#' \item{"y: "}{the original outcome variable.}
+#' \item{"x: "}{the final transformed input matrix used to fit the final model.}
+#' \item{"call_mfp: "}{the call to the `mfp2()` function.}
+#' \item{"family_string: "}{the family stored as character string.}
 #' }
 #' The `mfp2` object may contain further information depending on family.
 #'