Skip to content

Commit f89baad

Browse files
author
Nicolas Legrand
authored
Sphink links and graphvize dependencies (#65)
1 parent b034c2d commit f89baad

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ jobs:
2424

2525
- name: Build
2626
run: |
27-
conda install -c conda-forge python-graphviz
2827
pip install psychopy==2020.1.2
2928
pip install -r requirements-docs.txt
29+
sudo apt-get install graphviz
3030
sphinx-build -b html docs/source docs/build/html
3131
3232
- name: Deploy 🚀

docs/source/examples/psychophysics/1-psychophysics_subject_level.ipynb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -866,7 +866,8 @@
866866
"id": "YkJy6W8rBb6i"
867867
},
868868
"source": [
869-
"**Interpretation**: Here, $\\alpha$ refers to the threshold value (also the point of subjective equality for this design). This participant had a threshold at estimated at 2.25, which is just slightly positively biased. The $\\beta$ value refers to the slope. A higher value means lower precision. Here, the slope is estimated to be around 7.46 for this participant."
869+
"```{hint} Here, $\\alpha$ refers to the threshold value (also the point of subjective equality for this design). This participant had a threshold at estimated at 2.25, which is just slightly positively biased. The $\\beta$ value refers to the slope. A higher value means lower precision. Here, the slope is estimated to be around 7.46 for this participant.\n",
870+
"```"
870871
]
871872
},
872873
{

docs/source/stats.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Using the preprocessing function
44

5-
The {py:mod}`cardioception.reports` module includes a function {py:fun}`cardioception.reports.preprocessing` that automates the analysis and extraction of behavioural variables from the main outputs saved by the task. The function only requires the `final.txt` data frame (either the Pandas data frame or simply a path to the file) that is saved in each subject folder and will return a summary data frame containing the response time, the psychometric parameter estimated by the Psi algorithm and Bayesian inference as well as SDT measures and metacognitive efficiency (meta-d prime). This approach is the most straightforward to extract relevant parameters using default settings that will fit most users' needs.
5+
The reports module includes a [preprocessing function](cardioception.reports.preprocessing) that automates the analysis and extraction of behavioural variables from the main outputs saved by the task. The function only requires the `final.txt` data frame (either the Pandas data frame or simply a path to the file) that is saved in each subject folder and will return a summary data frame containing the response time, the psychometric parameter estimated by the Psi algorithm and Bayesian inference as well as SDT measures and metacognitive efficiency (meta-d prime). This approach is the most straightforward to extract relevant parameters using default settings that will fit most users' needs.
66

77
This script exemplifies how this function can be used to extract summary statistics from a result folder. It is assumed that the script is in a folder that contains the `data` folder in which the main outputs of the task are saved. You may addapt the following script to fit your needs:
88

@@ -35,7 +35,7 @@ summary_df.to_csv("results.tsv", sep="\t", index=False)
3535

3636
## Report templates
3737

38-
Here, you will find the report templates used to produce the HTML reports when calling the {py:fun}`cardioception.reports.report` function. We provide one for the Heart Rate Discrimination task and one for the Heart Beat Counting task. You can navigate the notebooks by clicking on the links or run it interactively in [Google Colab](https://colab.research.google.com/) using the badges, and upload your own data. Visualizing the data this way is recommended to assess the quality of the PPG recording or the general performance of the participant during the tasks.
38+
Here, you will find the report templates used to produce the HTML reports when calling the [report function](cardioception.reports.report) function. We provide one for the Heart Rate Discrimination task and one for the Heart Beat Counting task. You can navigate the notebooks by clicking on the links or run it interactively in [Google Colab](https://colab.research.google.com/) using the badges, and upload your own data. Visualizing the data this way is recommended to assess the quality of the PPG recording or the general performance of the participant during the tasks.
3939

4040
```{toctree}
4141
---

0 commit comments

Comments
 (0)