Skip to content

Commit

Permalink
Fix typos and extra note on Datatools Exercise (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
elenajal authored Jan 25, 2024
1 parent de79e26 commit 0c47cf0
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 7 deletions.
2 changes: 1 addition & 1 deletion ASReviewLAB.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ More detailed information about setting up a project can be found on
### Step 4: The dataset

Now that you have created your ASReview project (woohoo!), you need to set it
up.Without data, we have nothing to screen. So, you need to tell ELAS
up. Without data, we have nothing to screen. So, you need to tell ELAS
which dataset you want to screen for relevant articles.

Click on the ‘ADD’ button next to ‘Add dataset’. Now a menu appears
Expand Down
12 changes: 8 additions & 4 deletions datatools.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ in the main folder. This is where you will save the scripts you run.
Before we get started, we need a dataset that is already labeled. You can use a dataset from the SYNERGY dataset via the synergy-dataset Python package.

1. *Open the command prompt, by typing ‘cmd’ (for Windows) or
‘terminal’ (for Apple) in your computer’s search bar;*
‘terminal’ (for MacOS) in your computer’s search bar;*

2. *Navigate to the folder structure;*

Expand All @@ -36,13 +36,17 @@ You can navigate to your folder structure with:
``` bash
cd [file_path]
```
For MacOS:
1. Right-click on created folder.
2. Click “New Terminal at Folder”.
Then the data set will be automatically be put into the designated data folder.

3. *Install the synergy-dataset Python package with:*

``` bash
pip install synergy-dataset
```
4. *Built the dataset.*
4. *Build the dataset.*

To download and build the SYNERGY dataset, run the following command in the command line:

Expand All @@ -67,7 +71,7 @@ Note: if you installed ASReview datatools before, make sure you install the late
pip install --upgrade asreview-datatools
```

Before you are going to write your script, here is a general explaination of how you can get started with ASReview datatools. The parts between the brackets need to be filled out by you when using ASReview Datatools.
Before you are going to write your script, here is a general explanation of how you can get started with ASReview datatools. The parts between the brackets need to be filled out by you when using ASReview Datatools.

```bash
asreview data [name_of_tool]
Expand Down Expand Up @@ -96,7 +100,7 @@ Note: 'data/' is in front of the name of your dataset, since the datasets are st

### Tool 2: Compose

Next, you are going to compose a dataset out of two datasets; a labeled and an unlabeled dataset. The code starts similary to the code of the Describe tool (`asreview data compose`), but now the output path should always be specified (`output/[name_of_your_output_file.csv]`) and you need to assign a corresponsing proporty to the datasets you want to merge. The labeled dataset you need to assign the argument `-l` and the unlabeled dataset you need to assign a `-u`.
Next, you are going to compose a dataset out of two datasets; a labeled and an unlabeled dataset. The code starts similarly to the code of the Describe tool (`asreview data compose`), but now the output path should always be specified (`output/[name_of_your_output_file.csv]`) and you need to assign a corresponding property to the datasets you want to merge. To the labeled dataset you need to assign the argument `-l`, and to the unlabeled dataset you need to assign a `-u`.

Furthermore, in case of conflict, you need to determine which label to keep (`-c`). Let's say you want to keep one of the labels, you can do so with the `keep_one` command. By default the hierarchy in determining which label to keep is: relevant, irrelevant, unlabeled.

Expand Down
14 changes: 12 additions & 2 deletions simulation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -198,12 +198,17 @@ You can navigate to your folder structure with:
cd [file_path]
```

For MacOS:
1. Right-click on created folder.
2. Click “New Terminal at Folder”.
Then the data set will be automatically be put into the designated data folder.

3. *Install the synergy-dataset Python package with:*

``` bash
pip install synergy-dataset
```
4. *Built the dataset.*
4. *Build the dataset.*

To download and build the SYNERGY dataset, run the following command in the command line:

Expand All @@ -226,7 +231,7 @@ different models question 2 and 3).
The parts between the brackets \[ \] need to be filled out by you.

1. *Open the command prompt, by typing ‘cmd’ (for Windows) or
‘terminal’ (for Apple) in your computer’s search bar;*
‘terminal’ (for MacOS) in your computer’s search bar;*

2. *Navigate to the folder structure;*

Expand All @@ -239,6 +244,11 @@ cd [file_path]
The file_path is the path to the folder which you can copy and paste
from your explorer.

For MacOS:
1. Right-click on created folder.
2. Click “New Terminal at Folder”.
Then the data set will be automatically be put into the designated data folder.

3. *Run the simulation;*

Now, we’re going to write the script to run your simulation, using the
Expand Down

0 comments on commit 0c47cf0

Please sign in to comment.