Merge pull request #16 from ocbe-uio/issue-13

Ready for documentation work

DESCRIPTION

@@ -1,10 +1,35 @@
 Package: MADMMplasso
-Title: Multi variate multi response 'ADMM' with interaction effects
-Version: 0.0.0.9006
+Title: Multi Variate Multi Response 'ADMM' with Interaction Effects
+Version: 0.0.0.9007
 Authors@R:
-    c(person("Theophilus Quachie", "Asenso", , "t.q.asenso@medisin.uio.no", role = c("aut", "cre")),person("Manuela", "Zucknick", , "Manuela.zucknick@medisin.uio.no", role = c("aut")) )
-Description: This system allows one to model a multi response problem that has correlation among the
-	responses and also has main and interaction effects among the covariates.
+    c(
+        person(
+            given = "Theophilus Quachie", family = "Asenso",
+            email = "t.q.asenso@medisin.uio.no",
+            role = "aut"
+        ),
+        person(
+            given = "Manuela", family = "Zucknick",
+            email = "Manuela.zucknick@medisin.uio.no",
+            role = "aut"
+        ),
+        person(
+            given = "Waldir", family = "Leoncio",
+            email = "w.l.netto@medisin.uio.no",
+            role = c("aut", "cre"),
+            comment = c(ORCID = "0000-0002-6719-6162")
+        ),
+        person(
+            given = "Chi", family = "Zhang",
+            email = "andreachizhang@yahoo.com",
+            role = "aut"
+        )
+    )
+Description: This system allows one to model a multi response problem
+    that has correlation among the responses and also has main and interaction
+    effects among the covariates. The implementation is based on the methodology
+    presented on Quachie Asenso, T., & Zucknick, M. (2023)
+    <doi:10.48550/arXiv.2303.11155>.
 Imports:
     Matrix,
     MASS,

NAMESPACE

@@ -1,15 +1,15 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method(plot,MADMMplasso)
-S3method(plot,cv.MADMMplasso)
+S3method(plot,cv_MADMMplasso)
 S3method(predict,MADMMplasso)
 export(MADMMplasso)
-export(admm.MADMMplasso)
+export(admm_MADMMplasso)
 export(compute_pliable)
-export(cv.MADMMplasso)
-export(generate.my.w)
+export(cv_MADMMplasso)
+export(generate_my_w)
 export(sim2)
-export(tree.parms)
+export(tree_parms)
 import(Rcpp)
 import(RcppArmadillo)
 import(class)