From 29d49e87ab0cbf46b67ee294ac0abbd6dfd7c859 Mon Sep 17 00:00:00 2001
From: Johannes Titz <johannes@titz.science>
Date: Wed, 6 Dec 2023 20:37:42 +0100
Subject: [PATCH] docs: exlain return value for summary methods better

---
 man/summary.cofad_bw.Rd | 7 ++++---
 man/summary.cofad_mx.Rd | 5 +++--
 man/summary.cofad_wi.Rd | 5 +++--
 3 files changed, 10 insertions(+), 7 deletions(-)

diff --git a/man/summary.cofad_bw.Rd b/man/summary.cofad_bw.Rd
index 4912802..82657aa 100644
--- a/man/summary.cofad_bw.Rd
+++ b/man/summary.cofad_bw.Rd
@@ -4,7 +4,7 @@
 \alias{summary.cofad_bw}
 \title{Summary of between subject design contrast analysis}
 \usage{
-\method{summary}{cofad_bw}(object, ...)
+\method{summary}{cofad_bw}(object, type = "Contrast Analysis Between", ...)
 }
 \arguments{
 \item{object}{output of calc_contrast}
@@ -12,8 +12,9 @@
 \item{...}{further arguments}
 }
 \value{
-Displays ANOVA table of the contrastanalysis
-and the typical effectsizes.
+Displays type of contrast analysis, lambdas, t-table, ANOVA table and
+  typical effect sizes. If you assign this to a variable, it will be a list
+  with the elements Lambdas, tTable, FTable, Effects.
 }
 \description{
 Summary of between subject design contrast analysis
diff --git a/man/summary.cofad_mx.Rd b/man/summary.cofad_mx.Rd
index 32ae485..f54e3ad 100644
--- a/man/summary.cofad_mx.Rd
+++ b/man/summary.cofad_mx.Rd
@@ -12,8 +12,9 @@
 \item{...}{further arguments}
 }
 \value{
-Displays ANOVA table of the contrastanalysis
-and the typical effectsizes.
+Displays type of contrast analysis, lambdas, t-table, ANOVA table and
+  typical effect sizes. If you assign this to a variable, it will be a list
+  with the elements Lambdas, tTable, FTable, Effects.
 }
 \description{
 Summary of a mixed design contrast analysis
diff --git a/man/summary.cofad_wi.Rd b/man/summary.cofad_wi.Rd
index 6103560..aa08ba7 100644
--- a/man/summary.cofad_wi.Rd
+++ b/man/summary.cofad_wi.Rd
@@ -14,8 +14,9 @@
 \item{...}{further arguments}
 }
 \value{
-Displays ANOVA table of the contrastanalysis
-and the typical effectsizes.
+Displays type of contrast analysis, lambdas, t-table and typical
+  effect sizes. If you assign this to a variable, it will be a list with the
+  elements Lambdas, tTable, Effects.
 }
 \description{
 Summary of within subject design contrast analysis