Skip to content

Commit

Permalink
chore: improve docstring in functional_connectivity_spheres.py
Browse files Browse the repository at this point in the history
  • Loading branch information
synchon committed Oct 7, 2022
1 parent 73e4f62 commit 4f1083c
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions junifer/markers/functional_connectivity_spheres.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ class FunctionalConnectivitySpheres(BaseMarker):
Parameters
----------
coords: str
coords : str
The name of the coordinates list to use. See
:mod:`junifer.data.coordinates`
radius: float
radius : float
The radius of the sphere in mm. If None, the signal will be extracted
from a single voxel. See :class:`nilearn.maskers.NiftiSpheresMasker`
for more information.
agg_method: str
agg_method : str
The aggregation method to use.
See :func:`junifer.stats.get_aggfunc_by_name` for more information.
agg_method_params: dict, optional
agg_method_params : dict, optional
The parameters to pass to the aggregation method.
name : str, optional
The name of the marker. By default, it will use
Expand Down Expand Up @@ -111,6 +111,7 @@ def compute(self, input: Dict, extra_input: Optional[Dict] = None) -> Dict:
- 'row_names': Row names as a list.
- 'col_names': Col names as a list.
- 'kind': The kind of matrix (tril, triu or full)
"""
sa = SphereAggregation(
coords=self.coords,
Expand Down

0 comments on commit 4f1083c

Please sign in to comment.