From 91b86eb4508709f7e75086c3ed8e96f2698b26c0 Mon Sep 17 00:00:00 2001 From: Jonathan de Bruin Date: Sat, 23 Jan 2021 10:26:59 +0100 Subject: [PATCH] Add documentation on dataset requirements --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4c05e7d..ac9a018 100644 --- a/README.md +++ b/README.md @@ -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)