Merge pull request #458 from ajdapretnar/rename-geo

Rename GeoMap to Document Map

Author: ajdapretnar

doc/index.rst

@@ -23,7 +23,7 @@ Widgets
    widgets/corpusviewer
    widgets/wordcloud
    widgets/concordance
-   widgets/geomap
+   widgets/docmap
    widgets/wordenrichment
    widgets/duplicatedetection
 

doc/widgets/docmap.md

@@ -0,0 +1,35 @@
+Document Map
+============
+
+Displays geographic locations mentioned in the text.
+
+**Inputs**
+
+- Data: Data set.
+
+**Outputs**
+
+- Corpus: Documents containing mentions of selected geographical regions.
+
+**Document Map** widget shows geolocations from textual (string) data. It finds mentions of geographic names (countries and capitals) and displays distributions (frequency of mentions) of these names on a map. It works with any Orange widget that outputs a data table and that contains at least one string attribute. The widget outputs selected data instances, that is all documents containing mentions of a selected country (or countries).
+
+![](images/DocMap-stamped.png)
+
+1. Select the meta attribute you want to search geolocations by. The widget will find all mentions of geolocations in a text and display distributions on a map.
+2. Select the type of map you wish to display. The options are *World*, *Europe* and *USA*. You can zoom in and out of the map by pressing + and - buttons on a map or by mouse scroll.
+3. The legend for the geographic distribution of data. Countries with the boldest color are most often mentioned in the selected region attribute (highest frequency).
+
+To select documents mentioning a specific country, click on a country and the widget will output matching documents. To select more than one country hold Ctrl/Cmd upon selection.
+
+Example
+-------
+
+**Document Map** widget can be used for simply visualizing distributions of geolocations or for a more complex interactive data analysis. Here, we've queried [NY Times](nytimes.md) for articles on Slovenia for the time period of the last year (2015-2016). First we checked the results with [Corpus Viewer](corpusviewer.md).
+
+![](images/DocMap-Example.png)
+
+Then we sent the data to **Document Map** to see distributions of geolocations by *country* attribute. The attribute already contains country tags for each article, which is why **NY Times** is great in combinations with **Document Map**. We selected Germany, which sends all the documents tagged with Germany to the output. Remember, we queried **NY Times** for articles on Slovenia.
+
+We can again inspect the output with **Corpus Viewer**. But there's a more interesting way of visualizing the data. We've sent selected documents to [Preprocess Text](preprocesstext.md), where we've tokenized text to words and removed stopwords.
+
+Finally, we can inspect the top words appearing in last year's documents on Slovenia and mentioning also Germany with [Word Cloud](wordcloud.md).

doc/widgets/geomap.md

@@ -32,10 +32,10 @@ To use the widget, you must enter [your own API key](https://developer.nytimes.c
 Example
 -------
 
-**NYTimes** is a data retrieving widget, similar to [Twitter](twitter-widget.md) and [Wikipedia](wikipedia-widget.md). As it can retrieve geolocations, that is geographical locations the article mentions, it is great in combination with [GeoMap](geomap.md) widget.
+**NYTimes** is a data retrieving widget, similar to [Twitter](twitter-widget.md) and [Wikipedia](wikipedia-widget.md). As it can retrieve geolocations, that is geographical locations the article mentions, it is great in combination with [Document Map](docmap.md) widget.
 
 ![](images/NYTimes-Example1.png)
 
 First, let's query **NYTimes** for all articles on Slovenia. We can retrieve the articles found and view the results in [Corpus Viewer](corpusviewer.md). The widget displays all the retrieved features, but includes on selected features as text mining features.
 
-Now, let's inspect the distribution of geolocations from the articles mentioning Slovenia. We can do this with [GeoMap](geomap.md). Unsurprisingly, Croatia and Hungary appear the most often in articles on Slovenia (discounting Slovenia itself), with the rest of Europe being mentioned very often as well.
+Now, let's inspect the distribution of geolocations from the articles mentioning Slovenia. We can do this with [Document Map](docmap.md). Unsurprisingly, Croatia and Hungary appear the most often in articles on Slovenia (discounting Slovenia itself), with the rest of Europe being mentioned very often as well.

doc/widgets/icons/geomap.png doc/widgets/icons/docmap.png

@@ -32,10 +32,10 @@ class Map:
            ('USA',    USA))
 
 
-class OWGeoMap(widget.OWWidget):
-    name = "GeoMap"
+class OWDocMap(widget.OWWidget):
+    name = "Document Map"
     priority = 530
-    icon = "icons/GeoMap.svg"
+    icon = "icons/DocMap.svg"
 
     class Inputs:
         data = Input("Data", Table)
@@ -91,7 +91,7 @@ def _create_layout(self):
                       pathname2url(os.path.join(
                           os.path.dirname(__file__),
                           'resources',
-                         'owgeomap.html')))
+                          'owdocmap.html')))
 
         class Bridge(QObject):
             @pyqtSlot(str)
@@ -200,7 +200,7 @@ def main():
                              X=np.zeros((len(words), 0)),
                              metas=words)
     app = QApplication([''])
-    w = OWGeoMap()
+    w = OWDocMap()
     w.on_data(table)
     w.show()
     app.exec()