You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/post/2025-07-02-DataPipeOSF/index.md
+34-27Lines changed: 34 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,8 +21,7 @@ tags:
21
21
- Psychology
22
22
---
23
23
24
-
Hello there! 👋
25
-
Let's learn how to set up DataPipe to collect and save data in OSF.
24
+
Hello there! 👋 Let's learn how to set up DataPipe to collect and save data in OSF.
26
25
27
26
Lets start with some basics!
28
27
@@ -32,38 +31,38 @@ DataPipe is a tool that allows you to collect and save data in OSF (Open Science
32
31
33
32
## How to set up DataPipe in OSF
34
33
35
-
1.**Create an OSF Project**: Start by creating a new project in [OSF](https://osf.io/). This will be the container for your data and any related files. You can set up an account if you don't have one already, quite easily!
34
+
1.**Create an OSF Project**: Start by creating a new project in [OSF](https://osf.io/). This will be the container for your data and any related files. You can set up an account if you don't have one already, quite easily!
36
35
37
-
- Go to the OSF homepage and log in or create an account. You can easily sign up through institutional access.
38
-
- Click on "Create a New Project" and fill in the necessary details such as project title, description, and visibility settings. ***DO NOT SET IT AS PUBLIC*** as the data being saved will not be anonymized and may contain sensitive information.
36
+
- Go to the OSF homepage and log in or create an account. You can easily sign up through institutional access.
37
+
- Click on "Create a New Project" and fill in the necessary details such as project title, description, and visibility settings. ***DO NOT SET IT AS PUBLIC*** as the data being saved will not be anonymized and may contain sensitive information.
39
38
40
-
2.**Create OSF Token**: You will need to create a token to grant DataPipe the necessary permissions to access your OSF project.
39
+
2.**Create OSF Token**: You will need to create a token to grant DataPipe the necessary permissions to access your OSF project.
41
40
42
-
- Go to your OSF account settings and navigate to the "personal access tokens" section.
43
-
- Click on "Create a new token" and give it a name (e.g., "DataPipe Token").
44
-
- Set the permissions for the token, ensuring it has access to read and write data in your project.
45
-
- Copy the generated token; you will need it later.
41
+
- Go to your OSF account settings and navigate to the "personal access tokens" section.
42
+
- Click on "Create a new token" and give it a name (e.g., "DataPipe Token").
43
+
- Set the permissions for the token, ensuring it has access to read and write data in your project.
44
+
- Copy the generated token; you will need it later.
46
45
47
-
3.**Link OSF to DataPipe**: In DataPipe, you will need to link your OSF project using the token you created.
46
+
3.**Link OSF to DataPipe**: In DataPipe, you will need to link your OSF project using the token you created.
48
47
49
-
- Open DataPipe, click Account on the top right corner and select settings.
50
-
- Click on the 'Set OSF Token' button and paste the token you copied earlier.
48
+
- Open DataPipe, click Account on the top right corner and select settings.
49
+
- Click on the 'Set OSF Token' button and paste the token you copied earlier.
51
50
52
-
4.**Create new experiment on DataPipe**: Now that your OSF project is linked, you can create a new experiment in DataPipe.
51
+
4.**Create new experiment on DataPipe**: Now that your OSF project is linked, you can create a new experiment in DataPipe.
53
52
54
-
- Click on "Create New Experiment" in DataPipe.
55
-
- Give the experiment a name - I recommend using the same name as your OSF project for consistency.
56
-
-Add the OSF project ID to the experiment settings. You can find the project ID in the URL of your OSF project (it is the alphanumeric string after osf.io/)
57
-
-Create a new OSF Data component called 'data'. This will create a folder - named data - in your OSF project where all the data collected will be saved.
58
-
- Choose Germany - Frankfurt as the server location for your DataPipe experiment. This is important for data privacy and compliance with regulations such as GDPR.
53
+
- Click on "Create New Experiment" in DataPipe.
54
+
- Give the experiment a name - I recommend using the same name as your OSF project for consistency.
55
+
-Add the OSF project ID to the experiment settings. You can find the project ID in the URL of your OSF project (it is the alphanumeric string after osf.io/)
56
+
-Create a new OSF Data component called 'data'. This will create a folder - named data - in your OSF project where all the data collected will be saved.
57
+
- Choose Germany - Frankfurt as the server location for your DataPipe experiment. This is important for data privacy and compliance with regulations such as GDPR.
59
58
60
-
5.**Configure Data Collection**: Once the experiment is set up on DataPipe enable data collection on the Status section.
59
+
5.**Configure Data Collection**: Once the experiment is set up on DataPipe enable data collection on the Status section. You can optionally enable base64 data collection if you wish to encode any video, audio or image files as strings. 'Condition assignment' can also be enabled- this makes DataPipe loop through the conditions when it requests the data. When deciding whether these features are suitable, it's best to consider how you will preprocess the data. It's advised that you only enable the minimum needed as a security measure.
61
60
62
-
6.**Save the data from the experiment hosted on GitHub**: If you are using a GitHub repository to host your experiment, you can save the data collected by writing the bellow code to the experiment HTML file. This bit of code should be called at the end of your experiment to ensure that all data is saved to the OSF project
61
+
6.**Save the data from the experiment hosted on GitHub**: If you are using a GitHub repository to host your experiment, you can save the data collected by writing the below code to the experiment HTML file. This bit of code should be called at the end of your experiment to ensure that all data is saved to the OSF project
63
62
64
-
- Here is what the code should look like in your experiment HTML file:
63
+
-Here is what the code should look like in your experiment HTML file:
65
64
66
-
```javascript
65
+
```javascript
67
66
// Save data via DataPipe
68
67
timeline.push({
69
68
type: jsPsychPipe,
@@ -72,10 +71,18 @@ DataPipe is a tool that allows you to collect and save data in OSF (Open Science
72
71
filename:`${participantID}.csv`,
73
72
data_string: () =>jsPsych.data.get().csv(),
74
73
})
75
-
```
74
+
```
76
75
77
-
- On the experiment created on DataPipe, there is an 'Experiment ID'field. This is the ID you need to add to the `experiment_id` field in the code above.
78
-
- The `filename` field can be customized to include the participant ID or any other identifier you prefer.
76
+
- On the experiment created on DataPipe, there is an 'Experiment ID'field. This is the ID you need to add to the `experiment_id` field in the code above.
79
77
78
+
- The `filename` field can be customized to include the participant ID or any other identifier you prefer.
80
79
81
-
7.**Run Your Experiment**: With everything set up, you can now run your experiment. DataPipe will automatically collect and save the data to your OSF project as specified. *Give it a try!*
80
+
- If publishing your experiment to GitHub, make sure the link is
or *'https://[your username].github.io/[your repository name]/[name of experiment's html file]'* if the html file for your experiment is named anything other than `'index.html'`
85
+
86
+
7. **Run Your Experiment**: With everything set up, you can now run your experiment. DataPipe will automatically collect and save the data to your OSF project as specified.
87
+
88
+
*Give it a try!* If you'd like further clarification, the [DataPipe website](https://pipe.jspsych.org/getting-started) includes a useful outline.
0 commit comments