Skip to content

Commit

Permalink
Merge pull request #812 from fieldtrip/fname_short
Browse files Browse the repository at this point in the history
shorten filenames of page
  • Loading branch information
robertoostenveld authored Nov 28, 2024
2 parents 20ace60 + fbefc82 commit a731abf
Show file tree
Hide file tree
Showing 255 changed files with 593 additions and 296 deletions.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
18 changes: 7 additions & 11 deletions development/project/design.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Explain how to create cfg.design for ft_statistics
title: Explain how to create cfg.design for ft_xxxstatistics
---

{% include /shared/development/warning.md %}
Expand All @@ -10,14 +10,13 @@ cfg.design as input into ft_statistics (freq, timelock, or source) should be des

M is variable length. Along with cfg.design, the other options cfg.ivar, cfg.uvar, cfg.wvar, and cfg.cvar may also need to be specified. They are an index (indices) into which row(s) of the cfg.design correspond to 'independent variables', 'units of observation', 'within-block variables' and 'control variables', respectively.

Not all are needed: see statistics\_\*.m for what vectors it may include.
Not all are needed: see statistics_xxx_.m for what vectors it may include.

See https://www.fieldtriptoolbox.org/walkthrough#non-paired_comparison and https://www.fieldtriptoolbox.org/walkthrough#paired_comparison for examples on ivar and uvar.
and https://www.fieldtriptoolbox.org/development/statistics for uvar.
See https://www.fieldtriptoolbox.org/walkthrough#non-paired_comparison and https://www.fieldtriptoolbox.org/walkthrough#paired_comparison for examples on ivar and uvar, and https://www.fieldtriptoolbox.org/development/statistics for uvar.

Is there any explanation on the website for more on uvar and wvar? (Seems it is all on the email discussion list specific to people's questions).

##### links to already existing pages with some mention of design matrix
## links to already existing pages with some mention of design matrix

- https://www.fieldtriptoolbox.org/walkthrough
- https://www.fieldtriptoolbox.org/getting_started/biosemi
Expand All @@ -31,16 +30,13 @@ Is there any explanation on the website for more on uvar and wvar? (Seems it is
- https://www.fieldtriptoolbox.org/development/statistics
- https://www.fieldtriptoolbox.org/development/multivariate

##### Hierarchy of functions
## Hierarchy of functions

(figure/diagram helpful https://www.fieldtriptoolbox.org/development/statistics)

User calls ft\_\*statistics (freq, timelock, or source)
User calls ft_xxxstatistics (freq, timelock, or source) with cfg.method=xxx as different methods for calculating probability of null hypothesis, will call function: statistics_xxx.

cfg.method: different methods for calculating probability of null hypothesis
will call function: statistics_(cfg.method)

however, in ft_sourcestatistics, instead statistics(cfg.method) is called, or statistics_wrapper if no method specified.
However, in ft_sourcestatistics, instead statistics_xxx is called, or statistics_wrapper if no method specified.

statistics_montecarlo.m (only) calls resampledesign.m

Expand Down
6 changes: 3 additions & 3 deletions development/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,8 @@ For example, let's say you made a modification to the **[ft_preprocessing](/refe
% continue with the ones that specify the WALLTIME, MEG, DATA and DEPENDENCY
filtered_test = test(~skip,:);

You can then select the tests that for example depend on **[ft_preprocessing](/ft_preprocessing)**.
You can then select the tests that for example depend on **[ft_preprocessing](/reference/ft_preprocessing)**.

keepRows = contains(filtered_test.dependency, 'ft_preprocessing');
filtered_test = filtered_test(keepRows, :);

Expand Down Expand Up @@ -171,7 +171,7 @@ To link related scripts to background information on issues, please first file a

**Method C**: If that is also not possible, the result of the algorithm on a particular real-world dataset has to be interpreted as being correct, and that solution should be reused as reference solution (i.e. regression testing). For example, if a function calculates the [forward solution](https://www.fieldtriptoolbox.org/tutorial/headmodel_meg/) for a certain subject then it should be tested against a reference solution, which could be the forward solution of a subject in MNI coordinates.

Tests that need to load test data should include **[dccnpath](/utilities/dccnpath)** to ensure that every user has the correct path to the test data. This function takes as _input_ the path to where the file is located on DCCN central storage and compute cluster; the _output_ is the corresponding path to the file on your local computer. Publicly available data is downloaded automatically from the [download server](https://download.fieldtriptoolbox.org/).
Tests that need to load test data should include **[dccnpath](/reference/utilities/dccnpath)** to ensure that every user has the correct path to the test data. This function takes as _input_ the path to where the file is located on DCCN central storage and compute cluster; the _output_ is the corresponding path to the file on your local computer. Publicly available data is downloaded automatically from the [download server](https://download.fieldtriptoolbox.org/).

When you create a new test script, you should always include a _list of requirements and dependencies_ at the beginning of the script. For instance:

Expand Down
Loading

0 comments on commit a731abf

Please sign in to comment.