fxed some docstring syntax issues in data package
@@ -26,11 +26,9 @@ class DatasetBase:
measurements (numpy.ndarray): n_obs x n_channel 2d-array,
descriptors (dict): descriptors (metadata)
obs_descriptors (dict): observation descriptors (all
- are array-like with shape =
- (n_obs,...))
+ are array-like with shape = (n_obs,...))
channel_descriptors (dict): channel descriptors (all are
- array-like with shape =
- (n_channel,...))
+ array-like with shape = (n_channel,...))
Returns:
dataset object
@@ -103,6 +101,7 @@ class DatasetBase:
def subset_obs(self, by, value):
""" Returns a subsetted Dataset defined by certain obs value
+
Args:
by(String): the descriptor by which the subset selection is made
from obs dimension
@@ -117,6 +116,7 @@ class DatasetBase:
def subset_channel(self, by, value):
""" Returns a subsetted Dataset defined by certain channel value
+
Args:
by(String): the descriptor by which the subset selection is made
from channel dimension
@@ -161,6 +161,7 @@ class Dataset(DatasetBase):
def split_channel(self, by):
""" Returns a list Datasets splited by channels
+
Args:
by(String): the descriptor by which the splitting is made
@@ -186,6 +187,7 @@ class Dataset(DatasetBase):
def subset_obs(self, by, value):
""" Returns a subsetted Dataset defined by certain obs value
+
Args:
by(String): the descriptor by which the subset selection
is made from obs dimension
@@ -209,6 +211,7 @@ class Dataset(DatasetBase):
def subset_channel(self, by, value):
""" Returns a subsetted Dataset defined by certain channel value
+
Args:
by(String): the descriptor by which the subset selection is
made from channel dimension
