Skip to content

Commit 14fdead

Browse files
authored
Merge branch 'v0.4dev' into master
2 parents 4a4d8c6 + ee59378 commit 14fdead

21 files changed

Lines changed: 1246 additions & 282 deletions

dabest/_api.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,12 @@ def load(data, idx=None, x=None, y=None, paired=None, id_col=None,
2727
y : string, default None
2828
Column names for data to be plotted on the x-axis and y-axis.
2929
paired : string, default None
30-
The type of the experiment under which the data are obtained
30+
The type of the experiment under which the data are obtained. If 'paired'
31+
is None then the data will not be treated as paired data in the subsequent
32+
calculations. If 'paired' is 'baseline', then in each tuple of x, other
33+
groups will be paired up with the first group (as control). If 'paired' is
34+
'sequential', then in each tuple of x, each group will be paired up with
35+
its previous group (as control).
3136
id_col : default None.
3237
Required if `paired` is True.
3338
ci : integer, default 95

dabest/_bootstrap_tools.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,14 @@ class bootstrap:
1717
the two groups (x2-x1) is computed.
1818
NaNs are automatically discarded.
1919
20-
paired : string, default None
21-
The type of the experiment under which the data are obtained
22-
20+
paired: boolean, default False
21+
Whether or not x1 and x2 are paired samples. If 'paired' is None then
22+
the data will not be treated as paired data in the subsequent calculations.
23+
If 'paired' is 'baseline', then in each tuple of x, other groups will be
24+
paired up with the first group (as control). If 'paired' is 'sequential',
25+
then in each tuple of x, each group will be paired up with the previous
26+
group (as control).
27+
2328
statfunction: callable, default np.mean
2429
The summary statistic called on data.
2530

0 commit comments

Comments
 (0)