Merge branch 'add-get-type': Issue #2

eric-pedersen · Sep 27, 2018 · d6f62e3 · d6f62e3
2 parents b160098 + fed0df4
commit d6f62e3
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/R/utils.R b/R/utils.R
@@ -89,3 +89,14 @@
 `get_config` <- function(penalty) {
     attr(penalty, which = "mrf_config")
 }
+
+##' @title Extract the type of MRF from the penalty
+##'
+##' @param penalty an object of class `"mrf_penalty"`
+##'
+##' @return A length 1 character vector containing the type of MRF penalty.
+##'
+##' @export
+`get_type` <- function(penalty) {
+    get_config(penalty)[["type"]]
+}