Skip to content

Commit

Permalink
Fix covariate namings in usage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianWilhelm committed Jan 16, 2020
1 parent 1fe5349 commit 9e672c8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,10 @@ For those columns the following relationships hold:
- ``ite = mu_1 - mu_0``

Besides these columns, there are covariates (also called features) and optionally other columns for managing meta information
like datetime or an id of sample. Within the provided data sets covariates are called ``x_1``, ``x_2``, etc. but can take
any name if you use your own data set as explained below. Besides covariates, the provided data set have a column ``sample_id``
to easily identify one sample.
like datetime or an id of sample. Within the provided data sets covariates are called ``x_0``, ``x_1``, etc. but can take
any name if you use your own data set as explained below. The matrix of all covariates is ``X := [x_0, x_1, ..., x_n]``
and its usage is explained below.
Besides covariates, the provided data set have a column ``sample_id`` to easily identify one sample.

Replications
------------
Expand Down Expand Up @@ -95,7 +96,7 @@ As usual, ``cf.columns`` would list the names of all columns. To find out which
*others*, we can use the attribute accessor ``names``::

>>> cf.names.covariates
['0', '1', '2', '3', ..., '22', '23', '24']
['x_0', 'x_1', 'x_2', ..., 'x_22', 'x_23', 'x_24']
>>> cf.names.others
['sample_id']

Expand Down
1 change: 1 addition & 0 deletions src/justcause/data/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ def generate_data(
Returns:
a dataset as list of replications generated from the functions.
"""
random_state = check_random_state(random_state)

Expand Down

0 comments on commit 9e672c8

Please sign in to comment.