Skip to content

Commit 7f45229

Browse files

File tree

12 files changed

+19
-19
lines changed

12 files changed

+19
-19
lines changed

.circleci/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ commands:
5252
- run:
5353
name: 🔧 Configuring git user
5454
command: |
55-
git config --global user.email "[email protected].com"
55+
git config --global user.email "[email protected].io"
5656
git config --global user.name "ci-build"
5757
- run:
5858
name: 🔀 Combining new docs with existing docs

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Steps to build a release:
4747
- Only write a document once, and liberally use the [reStructured Text `.. include::` directive](https://docutils.sourceforge.io/docs/ref/rst/directives.html#include) to include that document where appropriate.
4848
- Use absolute paths for `.. include::`s. That way the path will resolve correctly regardless of differences in nesting levels.
4949
- Include any source documents that you want built in at least one [`toctree`](https://www.sphinx-doc.org/en/1.8/usage/restructuredtext/directives.html#directive-toctree). Use the `:hidden:` option if you don't want it linked in an actual table of contents in the document with the `toctree`.
50-
- Use consistent section title indicators throughout a sourcetree. [fcp-indi.github.com/docs/user](https://fcp-indi.github.com/docs/user) currently has the following hierarchy (top to bottom):
50+
- Use consistent section title indicators throughout a sourcetree. [fcp-indi.github.io/docs/user](https://fcp-indi.github.io/docs/user) currently has the following hierarchy (top to bottom):
5151
```
5252
=
5353
^
@@ -66,12 +66,12 @@ Steps to build a release:
6666
#### Let CircleCI build your drafts / works-in-progress
6767
* Build environment will match actual docs build environment
6868
* CircleCI takes ~2 minutes to build
69-
1. Fork https://github.com/FCP-INDI/fcp-indi.github.com
69+
1. Fork https://github.com/FCP-INDI/fcp-indi.github.io
7070
1. In your fork's settings, set the GitHub Pages `source` to `master` branch
7171
![GitHub Pages settings example screenshot](./images/github-pages-settings-example.png)
7272
1. Add your project on CircleCI
7373
1. Merge your draft / work-in-progress into your fork's `source` branch. Make sure you push to your fork and not the main repository's `source` branch.
74-
1. Your fork will publish at `https://[your_GitHub_username].github.io/fcp-indi.github.com/`.
74+
1. Your fork will publish at `https://[your_GitHub_username].github.io/fcp-indi.github.io/`.
7575

7676
<a id="markdown-build-locally-c-pac-≥-v180" name="build-locally-c-pac-≥-v180"></a>
7777
#### Build locally (C-PAC ≥ v1.8.0)
@@ -122,14 +122,14 @@ where `{width}` and `{height}` are the values already present in the existing `w
122122
<a id="markdown-references-and-citations" name="references-and-citations"></a>
123123
## References and citations
124124

125-
[sphinxcontrib-bibtex](https://sphinxcontrib-bibtex.readthedocs.io/) is installed and configured. This extension creates links between the citations and the reference in the reference list and formats citations in referenced BibTeX files using built-in or [custom styles](https://github.com/FCP-INDI/fcp-indi.github.com/blob/source/docs/_sources/references/style.py). To use this Sphinx extension,
125+
[sphinxcontrib-bibtex](https://sphinxcontrib-bibtex.readthedocs.io/) is installed and configured. This extension creates links between the citations and the reference in the reference list and formats citations in referenced BibTeX files using built-in or [custom styles](https://github.com/FCP-INDI/fcp-indi.github.io/blob/source/docs/_sources/references/style.py). To use this Sphinx extension,
126126

127-
1. Include your citations in a BibTeX file (see the `*.bib` files in [docs/_sources/references](https://github.com/FCP-INDI/fcp-indi.github.com/blob/source/docs/_sources/references) for examples).
127+
1. Include your citations in a BibTeX file (see the `*.bib` files in [docs/_sources/references](https://github.com/FCP-INDI/fcp-indi.github.io/blob/source/docs/_sources/references) for examples).
128128
2. Using the key (the text between the opening `{` and the first `,` in a BibTeX entry) use the ReStructuredText syntax `` :cite:`key` `` to cite your reference in a ReStructuredText file.
129129
3. Include a `.. bibliography::` directive somewhere on any page that you want to use this extension to format references and create two-way links between the references and citations. Specify the (one) BibTeX file for this reference list any formatting for the reference list in this directive. Both `:cite:` and `.. bibliography::` need to be rendered on the same page for the links to generate.
130130
4. If you will (or might) use more than one `.. bibliography::` directive on a single rendered page (including `.. include::` directives), choose a prefix for the keys and include that prefix in both the `:cite:` role (like `` :cite:`prefix-key` ``) and the bibliography directive (like `:keyprefix: prefix-`).
131131
5. If you want to include a header over a reference list, use the `.. rubric::` directive above its `.. bibliography` directive.
132-
6. If the entry type (e.g., `book`, `article`, `misc`) of any of the entries in your BibTeX file(s) is not included in [docs/_sources/references/style.py](https://github.com/FCP-INDI/fcp-indi.github.com/blob/source/docs/_sources/references/style.py), add a `get_{entry_type}_template` [Pybtex](https://pybtex.org) method to `CPAC_DocsStyle`.
132+
6. If the entry type (e.g., `book`, `article`, `misc`) of any of the entries in your BibTeX file(s) is not included in [docs/_sources/references/style.py](https://github.com/FCP-INDI/fcp-indi.github.io/blob/source/docs/_sources/references/style.py), add a `get_{entry_type}_template` [Pybtex](https://pybtex.org) method to `CPAC_DocsStyle`.
133133

134134
For example, if you have a BibTeX file called `cpac_citation.bib` that contains
135135

@@ -182,5 +182,5 @@ The rendered file should look something like
182182
:shell:
183183
:ellipsis: 0,9
184184
```
185-
* :heavy_plus_sign: Check [`.circleci/config.yml`](https://github.com/FCP-INDI/fcp-indi.github.com/blob/source/.circleci/config.yml) of the branch you're working from for build dependencies.
185+
* :heavy_plus_sign: Check [`.circleci/config.yml`](https://github.com/FCP-INDI/fcp-indi.github.io/blob/source/.circleci/config.yml) of the branch you're working from for build dependencies.
186186
* :octocat: Set an environment variable `GITHUBTOKEN` to a [personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) to increase [your API rate limit](https://developer.github.com/v3/#rate-limiting) from 60 to 5000 requests per hour (for getting [release notes from GitHub](https://github.com/FCP-INDI/C-PAC/releases)).

GUI/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!DOCTYPE html>
22
<meta charset="utf-8">
33
<script>
4-
window.location.href = "https://fcp-indi.github.com/C-PAC_GUI" + window.location.href.split('/GUI')[1]
4+
window.location.href = "https://fcp-indi.github.io/C-PAC_GUI" + window.location.href.split('/GUI')[1]
55
</script>

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# fcp-indi.github.com
1+
# fcp-indi.github.io
22

33
GitHub Pages repo for FCP-INDI
44

docs/_sources/user/alff.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ALFF is defined as the total power within the frequency range between 0.01 and 0
99

1010
Computation and Analysis Considerations
1111
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12-
All computations are performed in a subject's native space. After transforming voxel time series frequency information into the power domain, calculation of these measures is relatively simple. ALFF is calculated as the sum of amplitudes within a specific low frequency range. f/ALFF is calculated as a fraction of the sum of amplitudes across the entire frequency range detectable in a given signal. For both measures, amplitudes in subject-level maps are transformed into Z-scores to create standardized subject-level maps. Anatomical images and Z-score maps are then transformed into MNI152 standard space. For more detail on how CPAC computes these steps, please see the `ALFF and f/ALFF Page of the developer documentation <http://fcp-indi.github.com/docs/developer/workflows/alff.html>`_.
12+
All computations are performed in a subject's native space. After transforming voxel time series frequency information into the power domain, calculation of these measures is relatively simple. ALFF is calculated as the sum of amplitudes within a specific low frequency range. f/ALFF is calculated as a fraction of the sum of amplitudes across the entire frequency range detectable in a given signal. For both measures, amplitudes in subject-level maps are transformed into Z-scores to create standardized subject-level maps. Anatomical images and Z-score maps are then transformed into MNI152 standard space. For more detail on how CPAC computes these steps, please see the `ALFF and f/ALFF Page of the developer documentation <http://fcp-indi.github.io/docs/developer/workflows/alff.html>`_.
1313

1414
Though both ALFF and f/ALFF are sensitive mostly to signal from gray matter, ALFF is more prone to noise from physiological sources, particularly near the ventricles and large blood vessels (Zuo et al., 2008;2010). The figure below (from Zuo et al., 2010) shows areas in which ALFF shows higher amplitude than f/ALFF, as well as the relative sensitivity of these measures to gray matter.
1515

docs/_sources/user/appendix.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,7 @@ Installing C-PAC
411411
""""""""""""""""
412412
Congratulations, you are now ready to install C-PAC itself!
413413

414-
C-PAC is available for download from the `C-PAC Homepage <http://fcp-indi.github.com/>`__. Click the button labeled "Download as tar.gz". Unpack the downloaded archive and navigate to the new directory. To install C-PAC, run the command ``sudo python setup.py install``. C-PAC will be installed alongside your other python packages. If this fails, check to make sure that you have all the dependencies installed. You may also install C-PAC using the commands below:
414+
C-PAC is available for download from the `C-PAC Homepage <http://fcp-indi.github.io/>`__. Click the button labeled "Download as tar.gz". Unpack the downloaded archive and navigate to the new directory. To install C-PAC, run the command ``sudo python setup.py install``. C-PAC will be installed alongside your other python packages. If this fails, check to make sure that you have all the dependencies installed. You may also install C-PAC using the commands below:
415415

416416
.. code-block:: console
417417
@@ -432,7 +432,7 @@ Once you are able to successfully ``import CPAC`` it is safe to delete any setup
432432

433433
Updating C-PAC
434434
""""""""""""""
435-
C-PAC is being actively developed, and new versions (containing bug fixes and new features) are often released. To update to the latest version, simply download it from the `C-PAC Homepage <http://fcp-indi.github.com/>`__ and repeat the instructions in the `Installing C-PAC` section above. A list of previous versions and the changes they contain is available on the :doc:`Release Notes Page </user/rnotes>`.
435+
C-PAC is being actively developed, and new versions (containing bug fixes and new features) are often released. To update to the latest version, simply download it from the `C-PAC Homepage <http://fcp-indi.github.io/>`__ and repeat the instructions in the `Installing C-PAC` section above. A list of previous versions and the changes they contain is available on the :doc:`Release Notes Page </user/rnotes>`.
436436

437437
.. note::
438438

docs/_sources/user/centrality.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Computation and Analysis Considerations
1919
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2020
For each subject, the timeseries for each node is extracted and used to calculate a temporal correlation matrix which represents the connectivity between all nodes. A threshold is then applied to the correlation matrix to create an adjacency matrix which describes all nodes that have survived thresholding. In CPAC, users can choose to apply a threshold based on either sparsity, significance, or correlation strength. Threshold values should be chosen carefully, as they can strongly influence the results of centrality analysis (Zuo et al., 2012).
2121

22-
Of the three centrality measures computed by CPAC, Degree Centrality is the simplest, and is computed by counting the number of significant correlations between the timeseries of a given node and that of all other nodes in the adjacency matrix. Local Functional Connectivity Density should be faster because it only calculates neighboring connections which have weights above the threshold. On the other hand, Eigenvector Centrality is computed by identifying the first eigenvector of the adjacency matrix, which corresponds to the largest eigenvalue. Since EC is a recursive measure that takes into account the properties of connected nodes, the EC of a given node is proportional to the sum of the EC of all directly neighboring nodes. After computing the centrality measures, centrality maps are generated and standardized using Z-scores for use in group analysis (Zuo et al., 2012). For more detail on how CPAC computes these steps, please see the `Network Centrality Page of the developer documentation <http://fcp-indi.github.com/docs/developer/workflows/network_centrality.html>`_.
22+
Of the three centrality measures computed by CPAC, Degree Centrality is the simplest, and is computed by counting the number of significant correlations between the timeseries of a given node and that of all other nodes in the adjacency matrix. Local Functional Connectivity Density should be faster because it only calculates neighboring connections which have weights above the threshold. On the other hand, Eigenvector Centrality is computed by identifying the first eigenvector of the adjacency matrix, which corresponds to the largest eigenvalue. Since EC is a recursive measure that takes into account the properties of connected nodes, the EC of a given node is proportional to the sum of the EC of all directly neighboring nodes. After computing the centrality measures, centrality maps are generated and standardized using Z-scores for use in group analysis (Zuo et al., 2012). For more detail on how CPAC computes these steps, please see the `Network Centrality Page of the developer documentation <http://fcp-indi.github.io/docs/developer/workflows/network_centrality.html>`_.
2323

2424
Applications and Recommendations
2525
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

docs/_sources/user/futuredocs/basc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Computation and Analysis Considerations
2929

3030
#. The group stability matrix is fed into a clustering algorithm to derive stable clusters.
3131

32-
The figure below (taken from Garcia-Garcia et al.) shows a visual representation of these steps. For more detail on how CPAC computes these steps, please see the `BASC Page of the developer documentation <http://fcp-indi.github.com/docs/developer/workflows/basc.html>`_.
32+
The figure below (taken from Garcia-Garcia et al.) shows a visual representation of these steps. For more detail on how CPAC computes these steps, please see the `BASC Page of the developer documentation <http://fcp-indi.github.io/docs/developer/workflows/basc.html>`_.
3333

3434
.. figure:: /_images/basc_manu_schematic.png
3535

docs/_sources/user/group_mdmr.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Computation steps for CWAS are listed below as described by Shehzad and colleagu
1717

1818
#. The significance of these similarities and differences is assessed with a permutation test. This identifies brain regions whose whole-brain pattern of connectivity is significantly predicted by a particular phenotypic variable.
1919

20-
The figure below (taken from Shehzad et al., 2010) outlines these steps. For more detail on how C-PAC handles these computations, please see the `CWAS section of the developer documentation <http://fcp-indi.github.com/docs/developer/workflows/cwas.html>`_.
20+
The figure below (taken from Shehzad et al., 2010) outlines these steps. For more detail on how C-PAC handles these computations, please see the `CWAS section of the developer documentation <http://fcp-indi.github.io/docs/developer/workflows/cwas.html>`_.
2121

2222
.. figure:: /_images/cwas_shehzad_schematic.png
2323

docs/_sources/user/reho.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The figure above (taken from Yan and Zang, 2010) shows the default mode network
1111

1212
Computation and Analysis Considerations
1313
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14-
KCC is computed for every voxel in a subject, and is based on the time series of each voxel, the number of time points within a time series, and the number of voxels within a cluster (Zang et al, 2004). Depending on whether neighboring voxels are taken to include those on the side, edge, or corner of a given voxel, cluster size can be 7, 19, or 27 voxels, respectively. Values of KCC range from 0 to 1, with higher values indicating greater similarity between the activation pattern of a given voxel and that of its neighbors. Voxel-based maps are generated based on KCC values and then standardized using Z-scores in order to perform group analysis. For more detail on how CPAC handles these computations, please see the `ReHo section of the developer documentation <http://fcp-indi.github.com/docs/developer/workflows/reho.html>`_.
14+
KCC is computed for every voxel in a subject, and is based on the time series of each voxel, the number of time points within a time series, and the number of voxels within a cluster (Zang et al, 2004). Depending on whether neighboring voxels are taken to include those on the side, edge, or corner of a given voxel, cluster size can be 7, 19, or 27 voxels, respectively. Values of KCC range from 0 to 1, with higher values indicating greater similarity between the activation pattern of a given voxel and that of its neighbors. Voxel-based maps are generated based on KCC values and then standardized using Z-scores in order to perform group analysis. For more detail on how CPAC handles these computations, please see the `ReHo section of the developer documentation <http://fcp-indi.github.io/docs/developer/workflows/reho.html>`_.
1515

1616
.. figure:: /_images/reho_voxel_schematic.png
1717

0 commit comments

Comments
 (0)