Skip to content

Commit fe5acaf

Browse files
nnonno
authored
DOC: update datadb links (#221)
* DOC: update datadb links * BLD: include codecov config
1 parent 0a12f46 commit fe5acaf

8 files changed

Lines changed: 32 additions & 28 deletions

File tree

‎codecov.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
coverage:
2+
status:
3+
project:
4+
default: # default is the status check's name, not default settings
5+
target: auto
6+
threshold: 5

‎doc/source/cimec2016_intro.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ AK6 dataset
5050
-----------
5151
This dataset is used for exercises shown on the website (with answers), and you can use it to learn MVPA. It contains preprocessed data for 8 subjects from :cite:`CGG+12`. In this experiment, participants were presented with categories of six animals: 2 primates: monkeys and lemurs; 2 birds: mallard ducks and yellow-throated warblers; and 2 bugs: ladybugs and luna moths.
5252

53-
Download link: `tutorial data with AK6 data only <datadb-ak6-v0.3.zip>`_
53+
Download link: :datadb:`-ak6-`.
5454

5555
.. image:: _static/fmri_design.png
5656
:width: 400px
@@ -107,7 +107,7 @@ This dataset is used for both the tutorial and for the assignments.
107107

108108
It contains MEG data from a single participant viewing images of six categories; for details see the README file.
109109

110-
Download link: `tutorial data with MEEG obj6 data only <datadb-meg_obj6-v0.3.zip>`_.
110+
Download link: `tutorial data with MEEG obj6 data only :datadb:`-meg_obj6-`.
111111

112112
.. _cimec2016_intro_links:
113113

‎doc/source/conf.py‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -317,10 +317,7 @@ def format(self, person, abbr=True):
317317
# datadb_url=''
318318

319319
extlinks = {
320-
"datadb": (
321-
"https://github.com/CoSMoMVPA/CoSMoMVPA/releases/latest/download/%s",
322-
"Tutorial data: %s ",
323-
),
320+
"datadb": (datadb_url + "/datadb%sv0.3.zip", "tutorial data: datadb%sv0.3.zip"),
324321
"pb": ("_static/publish/run_%s.html", "Matlab output: run_%s"),
325322
"run_up": ("../_static/publish/%s.html", "Matlab output: %s"),
326323
"demo_up": ("../_static/publish/%s.html", "Matlab output: %s"),

‎doc/source/download.rst‎

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -100,18 +100,13 @@ The Matlab / Octave code (in ``mvpa/``) is required for analyses in CoSMoMVPA_;
100100

101101
* Get the tutorial data:
102102

103-
The full dataset is in the `tutorial data <datadb-v0.3.zip>`_ zip archive.
103+
For the full dataset, including ``AK6``, MEEG ``obj-6``, and surface data, see :datadb:`-`.
104104

105105
For :ref:`labman2017`: the tutorial data should already be on your work station.
106106

107+
For `PRNI 2016`_, we used fMRI ``AK6`` and MEEG ``obj-6``: only fMRI AK6 and MEEG obj6 data :datadb:`-ak6-meg_obj6`.
107108

108-
For `PRNI 2016`_, we used fMRI ``AK6`` and MEEG ``obj-6``: `tutorial data with fMRI AK6 and MEEG obj6 data only <datadb-ak6-meg_obj6-v0.3.zip>`_.
109-
110-
111-
For a minimal set of data (only fMRI AK6 data for the exercises), consider using `tutorial data with AK6 data only <datadb-ak6-v0.3.zip>`_
112-
113-
Additional MEEG ``obj-6`` data, used for the exercises, is here: `MEG obj6 data <datadb-meg_obj6-v0.3.zip>`_.
114-
109+
For a minimal set of data (only fMRI AK6 data for the exercises), consider using :datadb:`-ak6-`.
115110

116111
You can move the directory to another location on your file system, if desired.
117112

@@ -147,7 +142,7 @@ The Matlab / Octave code (in ``mvpa/``) is required for analyses in CoSMoMVPA_;
147142
tutorial_data_path=/Users/karen/datasets/CoSMoMVPA/datadb/tutorial_data
148143
output_data_path=/Users/karen/tmp/CoSMoMVPA_output
149144
150-
You can choose in which directory you would like to store the output for from running the examples and demonstrations; just make sture that the ``output_data_path`` directory exists. You can create a new directory for the output if you want.
145+
You can choose in which directory you would like to store the output for from running the examples and demonstrations; just make sure that the ``output_data_path`` directory exists. You can create a new directory for the output if you want.
151146

152147
.. _`test_local_setup`:
153148

‎doc/source/labman2017_intro.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,15 @@ Datasets
6262
++++++++
6363
For most of the course we will be using the AK6 dataset and the MEG obj6 dataset (described below). Although these can be downloaded separately, it is recommended however to use the full tutorial dataset.
6464

65-
Download link: `full tutorial data <datadb-v0.3.zip>`_.
65+
Download link: :datadb:`-`.
6666

6767
:ref:`labman2017` participants: this dataset should already be present on the lab computers, in which case there is no need to download this data.
6868

6969
AK6 dataset
7070
-----------
7171
This dataset is used for exercises shown on the website (with answers), and you can use it to learn MVPA. It contains preprocessed data for 8 subjects from :cite:`CGG+12`. In this experiment, participants were presented with categories of six animals: 2 primates: monkeys and lemurs; 2 birds: mallard ducks and yellow-throated warblers; and 2 bugs: ladybugs and luna moths.
7272

73-
Download link: `tutorial data with AK6 data only <datadb-ak6-v0.3.zip>`_
73+
Download link: :datadb:`-ak6-`
7474

7575
.. image:: _static/fmri_design.png
7676
:width: 400px
@@ -118,7 +118,7 @@ This dataset is used for both the tutorial and for the assignments.
118118

119119
It contains MEG data from a single participant viewing images of six categories; for details see the README file.
120120

121-
Download link: `tutorial data with MEEG obj6 data only <datadb-meg_obj6-v0.3.zip>`_.
121+
Download link: :datadb:`-meg_obj6-`.
122122

123123

124124

‎doc/source/nmsm2019_intro.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,13 @@ Datasets
6262
++++++++
6363
For most of the course we will be using the AK6 dataset and the MEG obj6 dataset (described below). Although these can be downloaded separately, it is recommended however to use the full tutorial dataset.
6464

65-
Download link: `full tutorial data <datadb-v0.3.zip>`_.
65+
Download link: :datadb:`-`.
6666

6767
AK6 dataset
6868
-----------
6969
This dataset is used for exercises shown on the website (with answers), and you can use it to learn MVPA. It contains preprocessed data for 8 subjects from :cite:`CGG+12`. In this experiment, participants were presented with categories of six animals: 2 primates: monkeys and lemurs; 2 birds: mallard ducks and yellow-throated warblers; and 2 bugs: ladybugs and luna moths.
7070

71-
Download link: `tutorial data with AK6 data only <datadb-ak6-v0.3.zip>`_
71+
Download link: :datadb:`-ak6-`.
7272

7373
.. image:: _static/fmri_design.png
7474
:width: 400px
@@ -116,7 +116,7 @@ This dataset is used for both the tutorial and for the assignments.
116116

117117
It contains MEG data from a single participant viewing images of six categories; for details see the README file.
118118

119-
Download link: `tutorial data with MEEG obj6 data only <datadb-meg_obj6-v0.3.zip>`_.
119+
Download link: :datadb:`-meg_obj6-`.
120120

121121

122122

‎doc/source/prni2016_intro.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ AK6 dataset
6666
-----------
6767
This dataset is used for exercises shown on the website (with answers), and you can use it to learn MVPA. It contains preprocessed data for 8 subjects from :cite:`CGG+12`. In this experiment, participants were presented with categories of six animals: 2 primates: monkeys and lemurs; 2 birds: mallard ducks and yellow-throated warblers; and 2 bugs: ladybugs and luna moths.
6868

69-
Download link: `tutorial data with AK6 data only <datadb-ak6-v0.3.zip>`_
69+
Download link: :datadb:`-ak6-`.
7070

7171
.. image:: _static/fmri_design.png
7272
:width: 400px
@@ -114,7 +114,7 @@ This dataset is used for both the tutorial and for the assignments.
114114

115115
It contains MEG data from a single participant viewing images of six categories; for details see the README file.
116116

117-
Download link: `tutorial data with MEEG obj6 data only <datadb-meg_obj6-v0.3.zip>`_.
117+
Download link: :datadb:`-meg_obj6-`.
118118

119119

120120

‎doc/source/quick_download.txt‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,21 @@
99

1010
* In that case, use :ref:`cosmo_set_path` to set the path.
1111

12-
- Full CoSMOMVPA tutorial data in `zip format <datadb-v0.3.zip>`_; used for :ref:`labman2017` and :ref:`nmsm2019`.
12+
- Tutorial data:
1313

14-
* fMRI AK6 and MEEG obj-6 data (for `PRNI 2016`_ exercises): `tutorial data with fMRI AK6 and MEEG obj6 data only <datadb-ak6-meg_obj6-v0.3.zip>`_
14+
+ Complete :datadb:`-`; used for :ref:`labman2017` and :ref:`nmsm2019`.
1515

16-
* A minimal set of data (only fMRI AK6 data for exercises): `tutorial data with AK6 data only <datadb-ak6-v0.3.zip>`_
16+
+ Subset with fMRI AK6 and MEEG obj-6 data (for `PRNI 2016`_ exercises): :datadb:`-ak6-meg_obj6-`.
1717

18-
* MEEG data (only obj-6 data for exercises): `tutorial data with MEEG obj6 data only <datadb-meg_obj6-v0.3.zip>`_
18+
+ Minimal set (only fMRI AK6 data for exercises): :datadb:`-ak6-`.
1919

20-
- CoSMOMVPA documentation in HTML format (for off-line viewing) is available in `zip <_static/CoSMoMVPA_documentation_html.zip>`_ and `gzipped tar archive <_static/CoSMoMVPA_documentation_html.tar.gz>`_.
20+
- CoSMOMVPA documentation:
21+
22+
+ ``git`` users::
23+
24+
git clone https://github.com/CoSMoMVPA/cosmomvpa.github.io.git
25+
26+
+ also available as `zip archive <https://github.com/CoSMoMVPA/cosmomvpa.github.io/archive/refs/heads/main.zip>`.
2127

2228

2329

0 commit comments

Comments
 (0)