Metadata-Version: 2.1
Name: asreview-wordcloud
Version: 0.4
Summary: Wordcloud tools for the ASReview project
Home-page: https://github.com/asreview/asreview-wordcloud
Author: Utrecht University
Author-email: asreview@uu.nl
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/asreview/asreview-wordcloud/issues
Project-URL: Source, https://github.com/asreview/asreview-wordcloud
Description: # ASReview-wordcloud
        
        ![Deploy and release](https://github.com/asreview/asreview-wordcloud/workflows/Deploy%20and%20release/badge.svg)![Build status](https://github.com/asreview/asreview-wordcloud/workflows/test-suite/badge.svg)
        
        This is a wordcloud supplemental package for the
        [ASReview](https://github.com/asreview/asreview) software. It is an easy way
        to create a visual impression of the contents of datasets.
        
        ## Installation
        
        The easiest way to install the wordcloud extension is to install from PyPI:
        
        ``` bash
        pip install asreview-wordcloud
        ```
        
        After installation of the wordcloud extension, `asreview` should automatically
        detect it. Test this by:
        
        ```bash
        asreview --help
        ```
        
        It should list the 'wordcloud' modus.
        
        ## Basic usage
        
        The dataset should 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:](https://asreview.readthedocs.io/en/latest/intro/datasets.html#benchmark-datasets)
        
        ![All texts](https://github.com/asreview/asreview-wordcloud/blob/main/figures/ptsd_all.png?raw=true)
        
        To make a wordcloud on titles only, use the `title` flag.
        
        ```
        asreview wordcloud MY_DATA.csv --title
        ```
        
        ![Titles only](https://github.com/asreview/asreview-wordcloud/blob/main/figures/ptsd_title.png?raw=true)
        
        To make a wordcloud on abstracts only, use the `abstract` flag.
        
        ```
        asreview wordcloud MY_DATA.csv --abstract
        ```
        
        ![Abstracts only](https://github.com/asreview/asreview-wordcloud/blob/main/figures/ptsd_abstract.png?raw=true)
        
        To make a wordcloud on relevant (inclusions) only, use the `relevant` flag.
        
        ```
        asreview wordcloud MY_DATA.csv --relevant
        ```
        
        ### Save figure
        
        Save the wordcloud to a file with the `-o`  flag.
        
        ```
        asreview wordcloud MY_DATA.csv -o MY_DATA_WORDCLOUD.png
        ```
        
        ## License
        
        This extension is MIT licensed.
        
Keywords: asreview wordcloud
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
