Skip to content

Commit

Permalink
Add documentation on dataset requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
J535D165 committed Jan 23, 2021
1 parent c123a46 commit 91b86eb
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,15 @@ It should list the 'wordcloud' modus.

## Basic usage

The dataset ahould contain a column containing titles and/or abstracts.
For specific requirements check the [ASReview documentation](https://asreview.readthedocs.io/en/latest/intro/datasets.html).
To use your data use:

```
asreview wordcloud MY_DATA.csv
```

The following shows the Schoot et al. (2017) dataset:
The following shows the [Schoot et al. (2017) dataset:](https://asreview.readthedocs.io/en/latest/intro/datasets.html#benchmark-datasets)

![figures/ptsd_all.png](figures/ptsd_all.png)

Expand Down

0 comments on commit 91b86eb

Please sign in to comment.