search

tramarobin / fctSnPM

Using spm1d package (v.0.4.3), compute anova and post-hoc tests from anova1 to anova3rm, with a non-parametric approach (permutation tests)
GNU General Public License v3.0
4 stars 2 forks source link

[JOSS Review] Installation instructions for novice MATLAB users #3

Closed 0todd0000 closed 3 years ago

0todd0000 commented 3 years ago

Please provide slightly more detailed installation instructions for novice users who might not understand paths and/or how to add specific directories to the MATLAB path.

tramarobin commented 3 years ago

The instructions were modified including 2 different lines of code to add the specific path.

0todd0000 commented 3 years ago

For the installation instructions, instead of this:

To add source code directory to your path use addpath(genpath("./fctSPM/src")) If your are running examples from ./fctSPM/Examples, you can use addpath(genpath("../src")) to add the source code directory to your path

I suggest:

Install this package by adding the src directory and its subdirectories to the MATLAB path. One way to do this is to call: addpath(genpath("./fctSPM/src")), where ./fctSPM/src is the full path to the src directory. Refer to the MATLAB documentation regarding search paths for alternative ways to set the path for current and future sessions.

As in issue #2, please do not perform installation procedures in the package demonstration scripts.

tramarobin commented 3 years ago

Thank you for the suggestion, the documentation was modified.

Concerning the issue #2, I will delete the concerned lines (I'll answer in the issue #2 when it is done and uploaded.)

0todd0000 commented 3 years ago

Thank you.

In the online documents please change /fctSPM/src to ./fctSPM/src.

If the command were addpath(genpath("x")), when citing x outside of this command it should exactly match what is inside the quotes to avoid confusion.

tramarobin commented 3 years ago

It was modified, sorry for the typo.

0todd0000 commented 3 years ago

OK, thank you.