Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes to documentation in FAQs and built-in components #70

Merged
merged 11 commits into from
Sep 30, 2022
Merged

Changes to documentation in FAQs and built-in components #70

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f090dac
Changes to documentation in fsq and buil
susanneweis Sep 14, 2022
e1eb199
chore: improve contribution guide in FAQ
synchon Sep 21, 2022
f375b2a
docs: add new section for setting up VSCode in FAQ
synchon Sep 21, 2022
c6eaf0e
docs: update datagrabbers in docs
synchon Sep 21, 2022
2be4477
docs: update markers in docs
synchon Sep 21, 2022
c225975
docs: update atlases in docs
synchon Sep 21, 2022
7b404c9
docs: rename builtin.rst section
synchon Sep 21, 2022
c51ef27
docs: fix docs for datagrabbers
synchon Sep 23, 2022
74b4e32
docs: update atlases
synchon Sep 23, 2022
60ec202
docs: fix UCLA dataset access type
synchon Sep 23, 2022
3d44dc2
docs: create separate contribution guidelines section and reference it
synchon Sep 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: update markers in docs
  • Loading branch information
@synchon
synchon committed Sep 28, 2022
commit 2be4477ca2be60cb29843b2b73dcb179100392e3
47 changes: 44 additions & 3 deletions docs/builtin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,9 @@ Planned
Markers
^^^^^^^

..
..
Provide a list of the Markers that are implemented or planned.

State: this should indicate the state of the dataset. Valid options are
- Planned
- In Progress
Expand All @@ -116,7 +116,10 @@ Markers
implementing the dataset. Links to github can be added by using the
following syntax: :gh:`<issue number>`

.. list-table:: Available data grabbers
Available
---------

.. list-table::
:widths: auto
:header-rows: 1

Expand All @@ -128,13 +131,51 @@ Markers
- Apply parcellation and perform aggregation function
- Done
- 0.0.1
* - :class:`junifer.markers.FunctionalConnectivityAtlas`
- Compute functional connectivity
- Done
- 0.0.1
* - :class:`junifer.markers.SphereAggregation`
- Spherical aggregation using mean
- Done
- 0.0.1
* - :class:`junifer.markers.RSSETSMarker`
- Compute root sum of squares of edgewise timeseries
- Done
- 0.0.1


Planned
-------

Available Atlases and Coordinates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. list-table::
:widths: auto
:header-rows: 1

* - Name
- Description
- Reference
* - Connectedness
- Compute connectedness
- :gh:`34`
* - ALFF and (f)ALFF
- Detect amplitude of low-frequency fluctuation (ALFF) for resting-state fMRI
- :gh:`35`
* - ReHo
- Calculate regional homogeneity
- :gh:`36`
* - Permutation entropy, Range entropy, Multiscale entropy and Hurst exponent
- Calculate Permutation entropy, Range entropy, Multiscale entropy and Hurst exponent
- :gh:`61`
* - EdgeCentricFC
- Calculate edge-centric functional connectivity
- :gh:`64`
* - CrossAtlasFC
- Calculate cross-atlas functional connectivity
- :gh:`85`

======== ============= ================================================================= =============
Name Options Keys Version added
Expand Down