Skip to content

Commit

Permalink
updated link to installation FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
robertoostenveld committed Dec 1, 2023
1 parent a317f61 commit 29359b7
Show file tree
Hide file tree
Showing 40 changed files with 40 additions and 40 deletions.
2 changes: 1 addition & 1 deletion _includes/shared/tutorial/headmodel_read_align.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Reading in the anatomical data

Before starting with FieldTrip, it is important that you set up your [MATLAB path](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path) properly.
Before starting with FieldTrip, it is important that you set up your [MATLAB path](/faq/installation) properly.

cd <path_to_fieldtrip>
ft_defaults
Expand Down
2 changes: 1 addition & 1 deletion development/project/femfuns.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Creating the environment is only needed once, but every new session where FEMfun

conda activate femfuns

Before starting with FieldTrip, it is important that you set up your [MATLAB path](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path) properly.
Before starting with FieldTrip, it is important that you set up your [MATLAB path](/faq/installation) properly.

cd <path_to_fieldtrip>
ft_defaults
Expand Down
2 changes: 1 addition & 1 deletion download.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You can download the FieldTrip toolbox [here](/download.php).

Prior to downloading, you might want to check whether your computer meets the [MATLAB requirements](/faq/requirements).

After downloading, you can follow the instructions in this [frequently asked question](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path) for setting up the MATLAB path.
After downloading, you can follow the instructions in this [frequently asked question](/faq/installation) for setting up the MATLAB path.

You can download the tutorial data [here](https://download.fieldtriptoolbox.org/tutorial/).

Expand Down
2 changes: 1 addition & 1 deletion faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ See also the [tutorials](/tutorial) and [example scripts](/example).
- [MATLAB complains that mexmaci64 cannot be opened because the developer cannot be verified](/faq/mexmaci64_cannot_be_opened_because_the_developer_cannot_be_verified)
- [MATLAB does not see the functions in the "private" directory](/faq/matlab_does_not_see_the_functions_in_the_private_directory)
- [MATLAB version 7.3 (2006b)_crashes_when_I_try_to_do_...](/faq/matlab_version_7.3_2006b_crashes_when_i_try_to_do)
- [Should I add FieldTrip with all subdirectories to my MATLAB path?](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path)
- [Should I add FieldTrip with all subdirectories to my MATLAB path?](/faq/installation)
- [The databrowser crashes and destroys the whole MATLAB session, how can I resolve this?](/faq/the_databrowser_crashes_and_destroys_the_whole_matlab_session_how_can_i_resolve_this)
- [What are the MATLAB requirements for using FieldTrip?](/faq/requirements)
- [What is the relation between "events" (such as_triggers) and "trials"?](/faq/what_is_the_relation_between_events_such_as_triggers_and_trials)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ tags: [faq, matlab, toolbox, path]

# Can I prevent "external" toolboxes from being added to my MATLAB path?

The recommended path settings are explained in this [frequently asked question](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path).
The recommended path settings are explained in this [frequently asked question](/faq/installation).

The code in the **[ft_defaults](/reference/ft_defaults)** function will execute only once and should preferably be executed in your `startup.m` file. The main FieldTrip functions will also call **[ft_defaults](/reference/ft_defaults)** to ensure that the required subdirectories are on the path.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ The common FieldTrip version on the shared network drive is automatically update

If you want to do your computations on your laptop or at home, you can use the download or github version.

See also this FAQ on [how to setup your FieldTrip path in MATLAB](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path).
See also this FAQ on [how to setup your FieldTrip path in MATLAB](/faq/installation).
2 changes: 1 addition & 1 deletion getting_started/blackrock.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ To read Blackrock data, you will need the NPMK toolbox. The latest version is av

## Set the path

To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path).
To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/installation).

addpath <path_to_fieldtrip>
ft_defaults
Expand Down
2 changes: 1 addition & 1 deletion getting_started/bti.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ FieldTrip knows how to deal with raw, i.e. unprocessed, data files. Data files w

## Set the path

To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path).
To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/installation).

addpath <path_to_fieldtrip>
ft_defaults
Expand Down
2 changes: 1 addition & 1 deletion getting_started/ctf.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ You should not store any scripts or mat files in the xxx.ds folder. When analyzi

## Set the path

To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path).
To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/installation).

addpath <path_to_fieldtrip>
ft_defaults
Expand Down
2 changes: 1 addition & 1 deletion getting_started/neuralynx.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Neuralynx also writes a raw data file (.nrd) in which all the channels are sampl

## Set the path

To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path).
To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/installation).

addpath <path_to_fieldtrip>
ft_defaults
Expand Down
2 changes: 1 addition & 1 deletion getting_started/neuromag.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Note that the MEG-PD toolbox will only function on 32-bit machines, and requires

## Set the path

To get started, you need to add the paths where the FieldTrip and MNE toolboxes can be found. You should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path).
To get started, you need to add the paths where the FieldTrip and MNE toolboxes can be found. You should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/installation).

addpath <path_to_fieldtrip>
ft_defaults
Expand Down
2 changes: 1 addition & 1 deletion getting_started/plexon.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The .plx files contain the multiplexed raw acquisition data. During acquisition

There are some constraints related to the way that FieldTrip represents continuous and spike data. All main FieldTrip functions read continuous data using the **[ft_read_header](/reference/fileio/ft_read_header)** and **[ft_read_data](/reference/fileio/ft_read_data)** functions. These functions require the continuous data in all channels contained in the file to have the same sampling frequency. This can be a problem because Plexon file formats often contain both 40kHz spike data and 1kHz sampled LFP data in the same file. One solution is to resave all source files into two separate files. The other is to modify the fileio functions to select the correct sampling frequency and channels.

To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path).
To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/installation).

addpath <path_to_fieldtrip>
ft_defaults
Expand Down
2 changes: 1 addition & 1 deletion getting_started/realtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The general idea behind the real-time processing of EEG/MEG data in FieldTrip in
To get some quick satisfaction with streaming data, you might want to try out the example given in this [frequently asked question](/faq/how_should_i_get_started_with_the_fieldtrip_realtime_buffer).
{% include markup/end %}

To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path).
To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/installation).

addpath <path_to_fieldtrip>
ft_defaults
Expand Down
2 changes: 1 addition & 1 deletion getting_started/ricoh.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The functions in FieldTrip that allows you to execute the pre-processing and co-

## Set the path

To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path). You also need to set the path to your data files.
To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/installation). You also need to set the path to your data files.

addpath <path_to_fieldtrip>
ft_defaults
Expand Down
2 changes: 1 addition & 1 deletion getting_started/yokogawa.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Usually you will be starting your FieldTrip analysis with raw continuous data wh

## Set the path

To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path).
To get started, you should add the FieldTrip main directory to your path, and execute the **[ft_defaults](/reference/ft_defaults)** function, which sets the defaults and configures up the minimal required path settings. See also this [frequently asked question](/faq/installation).

addpath <path_to_fieldtrip>
ft_defaults
Expand Down
2 changes: 1 addition & 1 deletion tutorial/distributedcomputing_parfor.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ This tutorial requires the original MEG datasets for the four subjects, plus one

Additional prerequisites:

- Make sure FieldTrip is on your path, see this [FAQ](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path)
- Make sure FieldTrip is on your path, see this [FAQ](/faq/installation)
- Have the necessary data next to each other in a single directory: the directories 'Subject01.ds', 'Subject02.ds', 'Subject03.ds', 'Subject04.ds', 'SubjectSEF.ds' should all be next to each other.
- Put your test scripts also in this directory

Expand Down
2 changes: 1 addition & 1 deletion tutorial/electrode.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The structure sensor is attached to an iPad mini. We use the [Scanner - Structur

[Here](https://download.fieldtriptoolbox.org/tutorial/electrode/3D-Scan.zip) you can download the result of the 3D-scan that we will use in this tutorial. Note that the Structure Sensor data comprises three files that should be kept together: an `.obj` file with the geometry, a `.jpg` file with the color photo texture mapping, and an `.mtl` file that maps between the geometry and the colors. If the `.mtl` and `.jpg` file are missing, there is no color information for the mesh.

Before starting with FieldTrip, it is important that you set up your [MATLAB path](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path) properly.
Before starting with FieldTrip, it is important that you set up your [MATLAB path](/faq/installation) properly.

cd <path_to_fieldtrip>
ft_defaults
Expand Down
2 changes: 1 addition & 1 deletion tutorial/epilepsy.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ surgery, though the extent of the polymicrogyria rendered this a difficult
option.
{% include markup/end %}

The shared data is available from our [download server](https://download.fieldtriptoolbox.org/tutorial/epilepsy/). After downloading the data, we set up the path and ensure that FieldTrip is the only toolbox on the path. See also [this FAQ](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path).
The shared data is available from our [download server](https://download.fieldtriptoolbox.org/tutorial/epilepsy/). After downloading the data, we set up the path and ensure that FieldTrip is the only toolbox on the path. See also [this FAQ](/faq/installation).

restoredefaultpath
addpath ~/matlab/fieldtrip/
Expand Down
2 changes: 1 addition & 1 deletion tutorial/headmodel_meg.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ _Figure 2. Pipeline of creating and visualizing a head model_

### Reading in the anatomical data

Before starting to use FieldTrip, it is important that you set up your MATLAB path properly. You can read about how to set up your MATLAB path [here](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path).
Before starting to use FieldTrip, it is important that you set up your MATLAB path properly. You can read about how to set up your MATLAB path [here](/faq/installation).

cd <path_to_fieldtrip>
ft_defaults
Expand Down
2 changes: 1 addition & 1 deletion tutorial/human_ecog.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Intracranial EEG (iEEG) allows simultaneous recordings from tens to hundreds of

Before we start, it is important to emphasize that human iEEG datasets are solely acquired for clinical purposes and come in different shapes and sizes. Some medical institutes use photography or X-ray (e.g., see [Analysis of monkey ECoG recordings)](/tutorial/monkey_ecog) for including anatomy in the analysis of the functional recordings, whilst others use CT (3D image from a series of X-rays) and/or MR, or combinations thereof. The example iEEG dataset used in this tutorial is not representative for all the datasets obtained in the field but it is meant to serve as a platform for thinking and dealing with the challenges associated with analyzing this type of data.

The tutorial demonstrates the analysis of task-related high-frequency-band activity (~70 to 150 Hz), a prominent neural signature in intracranial data that has been associated with neuron population level firing rate. Many other supported analyses such as event-related potential analysis, connectivity analysis, and statistical analysis have been described in detail elsewhere (Oostenveld et al., 2011; Maris & Oostenveld, 2007; Bastos & Schoffelen, 2016). You will need the iEEG data of SubjectUCI29, which can be obtained from [here](https://doi.org/10.5281/zenodo.1201560). If you are getting started with FieldTrip, download the most recent version from its homepage or GitHub and [set up your MATLAB path](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path).
The tutorial demonstrates the analysis of task-related high-frequency-band activity (~70 to 150 Hz), a prominent neural signature in intracranial data that has been associated with neuron population level firing rate. Many other supported analyses such as event-related potential analysis, connectivity analysis, and statistical analysis have been described in detail elsewhere (Oostenveld et al., 2011; Maris & Oostenveld, 2007; Bastos & Schoffelen, 2016). You will need the iEEG data of SubjectUCI29, which can be obtained from [here](https://doi.org/10.5281/zenodo.1201560). If you are getting started with FieldTrip, download the most recent version from its homepage or GitHub and [set up your MATLAB path](/faq/installation).

{% include markup/warning %}
The information on this page originates from the human intracranial data analysis protocol described in Stolk, Griffin et al., **[Integrated analysis of anatomical and electrophysiological human intracranial data](https://doi.org/10.1038/s41596-018-0009-6)**, Nature Protocols, 2018. Please cite that paper when you use the methods described here.
Expand Down
2 changes: 1 addition & 1 deletion tutorial/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ FieldTrip is composed of a collection of scripts running in MATLAB. The toolbox

It is now possible to execute the MATLAB scripts by copying/pasting the relevant text from the tutorials (To copy from a Window browser to MATLAB running under Linux from X-Win32, use the mouse to highlight the text in the browser and press crtl-c. Then use ctrl-v or the middle mouse button to paste in MATLAB).

Make sure that the path is set correctly to the directory of the FieldTrip toolbox and the data. For the tutorials it is recommend to 'cd' to the directory where the data are. Look at [this FAQ](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path) for more information on how to correctly set your path for FieldTrip.
Make sure that the path is set correctly to the directory of the FieldTrip toolbox and the data. For the tutorials it is recommend to 'cd' to the directory where the data are. Look at [this FAQ](/faq/installation) for more information on how to correctly set your path for FieldTrip.

## Making an analysis protocol

Expand Down
2 changes: 1 addition & 1 deletion tutorial/nirs_singlechannel.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ _Figure 1: Overview of a standard fNIRS analysis procedure._

### Getting Started

The dataset that we would like to analyze is called 'motor_cortex.oxy3'. First, we need to point FieldTrip to this file. Note that FieldTrip does not feature a graphical-user interface, but instead requires you to script your way to the end goal. To let MATLAB know that we want to use FieldTrip and it's file locations, add the FieldTrip folder to your path ([without subfolders](/faq/should_i_add_fieldtrip_with_all_subdirectories_to_my_matlab_path)) and then execute the **[ft_defaults](/reference/ft_defaults)** function by typing:
The dataset that we would like to analyze is called 'motor_cortex.oxy3'. First, we need to point FieldTrip to this file. Note that FieldTrip does not feature a graphical-user interface, but instead requires you to script your way to the end goal. To let MATLAB know that we want to use FieldTrip and it's file locations, add the FieldTrip folder to your path ([without subfolders](/faq/installation)) and then execute the **[ft_defaults](/reference/ft_defaults)** function by typing:

ft_defaults

Expand Down
Loading

0 comments on commit 29359b7

Please sign in to comment.