From 7160c1efff1e1964018bc65e1553c9fd00515ed5 Mon Sep 17 00:00:00 2001 From: Waldir Leoncio Date: Thu, 23 May 2024 14:50:29 +0200 Subject: [PATCH] Added description to function (#5) --- R/RcppExports.R | 2 +- man/admm_MADMMplasso_cpp.Rd | 2 +- src/admm_MADMMplasso.cpp | 3 +-- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/R/RcppExports.R b/R/RcppExports.R index 0176650..9b0b51d 100644 --- a/R/RcppExports.R +++ b/R/RcppExports.R @@ -33,7 +33,7 @@ #' @param my_print Should information form each ADMM iteration be printed along the way? Default TRUE. This prints the dual and primal residuals #' @param gg penalty terms for the tree structure for lambda_1 and lambda_2 for the admm call. #' @return predicted values for the ADMM part -#' @description TODO: add description +#' @description This function fits a multi-response pliable lasso model over a path of regularization values. #' @export admm_MADMMplasso_cpp <- function(beta0, theta0, beta, beta_hat, theta, rho1, X, Z, max_it, W_hat, XtY, y, N, e_abs, e_rel, alpha, lambda, alph, svd_w_tu, svd_w_tv, svd_w_d, C, CW, gg, my_print = TRUE) { .Call(`_MADMMplasso_admm_MADMMplasso_cpp`, beta0, theta0, beta, beta_hat, theta, rho1, X, Z, max_it, W_hat, XtY, y, N, e_abs, e_rel, alpha, lambda, alph, svd_w_tu, svd_w_tv, svd_w_d, C, CW, gg, my_print) diff --git a/man/admm_MADMMplasso_cpp.Rd b/man/admm_MADMMplasso_cpp.Rd index 5995022..d266146 100644 --- a/man/admm_MADMMplasso_cpp.Rd +++ b/man/admm_MADMMplasso_cpp.Rd @@ -92,5 +92,5 @@ However, user decide on a specific structure and then input a tree that follows predicted values for the ADMM part } \description{ -TODO: add description +This function fits a multi-response pliable lasso model over a path of regularization values. } diff --git a/src/admm_MADMMplasso.cpp b/src/admm_MADMMplasso.cpp index 6c6046f..929f717 100644 --- a/src/admm_MADMMplasso.cpp +++ b/src/admm_MADMMplasso.cpp @@ -34,7 +34,7 @@ //' @param my_print Should information form each ADMM iteration be printed along the way? Default TRUE. This prints the dual and primal residuals //' @param gg penalty terms for the tree structure for lambda_1 and lambda_2 for the admm call. //' @return predicted values for the ADMM part -//' @description TODO: add description +//' @description This function fits a multi-response pliable lasso model over a path of regularization values. //' @export // [[Rcpp::export]] arma::field admm_MADMMplasso_cpp( @@ -378,7 +378,6 @@ arma::field admm_MADMMplasso_cpp( // Return important values arma::field out(7); - // TODO: print all dimensions to make sure they are correct out(0) = arma::cube(beta0.n_elem, 1, 1); out(0).slice(0) = beta0;