Updated pid documentation

loosolab · Mar 1, 2017 · 2f2b483 · 2f2b483
1 parent 9ab9b10
commit 2f2b483
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 8 deletions.
diff --git a/R/pid.R b/R/pid.R
@@ -6,10 +6,12 @@
 #' @param discrete Whether the input is discretized
 #'
 #' @return A list with the following components:
-#' * unique_x1: The unique information provided by X1.
-#' * unique_x2: The unique information provided by X2.
-#' * synergy: The synergistic information provided by X1 and X2.
-#' * redundancy: The redundant information of X1 and X2.
+#'   \itemize{
+#'     \item{"unique_x1"}{The unique information provided by X1.}
+#'     \item{"unique_x2"}{The unique information provided by X2.}
+#'     \item{"synergy"}{The synergistic information provided by X1 and X2.}
+#'     \item{"redundancy"}{The redundant information of X1 and X2.}
+#'     }
 #'
 #' @examples
 #' data(circuit_data)

diff --git a/man/pid.Rd b/man/pid.Rd