[DOC] Update docstrings for null models #62
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- This commit updates the dosctrings of the null model functions. More specifically, the docstrings for the burt2018, burt2020 and moran null models now specify that data can be either a Gifti or a Nifti file (and not niimg_like only). The docstrings also specify that the atlas for these three models can also be volumetric (i.e. mni152). - The nifti file for the 2009cAsym 1mm brain mask appeared to be corrupted (it could not be loaded). I hence re-uploaded the file on OSF, and updated the osf.json file accordingly
This is another update to the docstrings of the null model functions. I added the `data_or_none_surface` entry in the _null_input_docs, which describe the available types of the data parameter in the `alexander_bloch` function.
We introduce new "names" for specific parameter types. Perhaps they could be implemented in the rest of the documentation later on? We use `path-like` to describe `str` or `os.PathLike` as objects pointing to an image file, `giimg-like` to describe surface-based images (e.g. `nib.GiftiImage`) and `niimg-like` to describe volumetric images (e.g. `nib.Nifti1Image`).
github-actions bot
pushed a commit
that referenced
this pull request
Jul 25, 2022
[DOC] Update docstrings for null models 614a3d5
github-actions bot
pushed a commit
to liuzhenqi77/neuromaps
that referenced
this pull request
Jul 26, 2022
[DOC] Update docstrings for null models 614a3d5
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This Pull Request updates the dosctrings of the null model functions. More
specifically, the docstrings for the
burt2018,burt2020andmorannullmodels now specify that data can be either a Gifti or a Nifti file (and
not niimg_like only). The docstrings also specify that the atlas for these
three models can also be volumetric (i.e.
mni152).The nifti file for the 2009cAsym 1mm brain mask appeared to be
corrupted (it could not be loaded). I hence re-uploaded the file on
OSF, and updated the osf.json file accordingly