From aa6ebe9ad0af2f1ec06e4cc8fc99d13cd859f34f Mon Sep 17 00:00:00 2001
From: egillax <egillax@gmail.com>
Date: Mon, 27 Jan 2025 13:16:24 +0100
Subject: [PATCH] docs

---
 R/ExtractData.R              | 3 +++
 R/SklearnClassifierHelpers.R | 3 +--
 man/listCartesian.Rd         | 3 +--
 man/print.plpData.Rd         | 3 +++
 man/print.summary.plpData.Rd | 3 +++
 man/summary.plpData.Rd       | 3 +++
 6 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/R/ExtractData.R b/R/ExtractData.R
index caf9f96a..b53a0339 100644
--- a/R/ExtractData.R
+++ b/R/ExtractData.R
@@ -437,6 +437,7 @@ getPlpData <- function(
 
 #' Print a plpData object
 #' @method print plpData
+#' @param x The plpData object to print
 #' @return A message describing the object
 #' @export
 print.plpData <- function(x, ...) {
@@ -448,6 +449,7 @@ print.plpData <- function(x, ...) {
 
 #' Summarize a plpData object
 #' @method summary plpData
+#' @param object The plpData object to summarize'
 #' @return A summary of the object containing the number of people, outcomes and covariates
 #' @export
 summary.plpData <- function(object, ...) {
@@ -477,6 +479,7 @@ summary.plpData <- function(object, ...) {
 #' Print a summary.plpData object
 #' @export
 #' @method print summary.plpData
+#' @param x The summary.plpData object to print
 #' @return A message describing the object
 print.summary.plpData <- function(x, ...) {
   writeLines("plpData object summary")
diff --git a/R/SklearnClassifierHelpers.R b/R/SklearnClassifierHelpers.R
index 26d596ca..412542fd 100644
--- a/R/SklearnClassifierHelpers.R
+++ b/R/SklearnClassifierHelpers.R
@@ -23,8 +23,7 @@
 #' @param allList a list of lists
 #' @return A list with all possible combinations from the input list of lists
 #' @examples
-#' results <- listCartesian(list(list(1, 2), list(3, 4))
-#' results
+#' listCartesian(list(list(1, 2), list(3, 4))
 #' @export
 listCartesian <- function(allList) {
   combinations <- expand.grid(allList)
diff --git a/man/listCartesian.Rd b/man/listCartesian.Rd
index f47a89fa..464fe228 100644
--- a/man/listCartesian.Rd
+++ b/man/listCartesian.Rd
@@ -16,6 +16,5 @@ A list with all possible combinations from the input list of lists
 Computes the Cartesian product of all the combinations of elements in a list
 }
 \examples{
-results <- listCartesian(list(list(1, 2), list(3, 4))
-results
+listCartesian(list(list(1, 2), list(3, 4))
 }
diff --git a/man/print.plpData.Rd b/man/print.plpData.Rd
index 0897c560..24235d3e 100644
--- a/man/print.plpData.Rd
+++ b/man/print.plpData.Rd
@@ -6,6 +6,9 @@
 \usage{
 \method{print}{plpData}(x, ...)
 }
+\arguments{
+\item{x}{The plpData object to print}
+}
 \value{
 A message describing the object
 }
diff --git a/man/print.summary.plpData.Rd b/man/print.summary.plpData.Rd
index 96a5967d..93f5f4fd 100644
--- a/man/print.summary.plpData.Rd
+++ b/man/print.summary.plpData.Rd
@@ -6,6 +6,9 @@
 \usage{
 \method{print}{summary.plpData}(x, ...)
 }
+\arguments{
+\item{x}{The summary.plpData object to print}
+}
 \value{
 A message describing the object
 }
diff --git a/man/summary.plpData.Rd b/man/summary.plpData.Rd
index 7ca068eb..f60f3f7e 100644
--- a/man/summary.plpData.Rd
+++ b/man/summary.plpData.Rd
@@ -6,6 +6,9 @@
 \usage{
 \method{summary}{plpData}(object, ...)
 }
+\arguments{
+\item{object}{The plpData object to summarize'}
+}
 \value{
 A summary of the object containing the number of people, outcomes and covariates
 }