Skip to content

Commit

Permalink
I want a new release
Browse files Browse the repository at this point in the history
  • Loading branch information
OneAdder committed Jun 12, 2019
1 parent 2455864 commit b89c4f3
Show file tree
Hide file tree
Showing 4 changed files with 127 additions and 147 deletions.
68 changes: 36 additions & 32 deletions docs/db_apis.html

Large diffs are not rendered by default.

88 changes: 53 additions & 35 deletions docs/docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -13163,9 +13163,9 @@ <h3 id="LingMap-Class">LingMap Class<a class="anchor-link" href="#LingMap-Class"
<li><p><strong>start_location</strong>: <em>(float, float)</em> or <em>str</em>, default <em>(0, 0)</em></p>
<p>Coordinates of the start location for the map <em>(latitude,
longitude)</em> or a text shortcut. List of available shortcuts:
<em>\"Central Europe\", \"Caucasus\", \"Australia &amp; Oceania\", \"Papua
New Guinea\", \"Africa\", \"Asia\", \"North America\", \"Central
America\", \"South America\"</em>.</p>
<em>"Central Europe", "Caucasus", "Australia &amp; Oceania", "Papua
New Guinea", "Africa", "Asia", "North America", "Central
America", "South America"</em>.</p>
</li>
<li><p><strong>start_zoom</strong>: <em>int</em>, default <em>2</em></p>
<p>Initial zoom level. Bypassed if you are using a shortcut
Expand Down Expand Up @@ -13205,13 +13205,12 @@ <h3 id="LingMap-Class">LingMap Class<a class="anchor-link" href="#LingMap-Class"
<p>Stroke legend position. Available values: 'right', 'left', 'top',
'bottom', 'bottomright', 'bottomleft', 'topright', 'topleft'.</p>
</li>
<li><p><strong>colors</strong>: <em>list</em> of html codes for colors (<em>str</em>).</p>
<li><p><strong>colors</strong>: <em>list</em> of html codes for colors (<em>str</em>), default <em>None</em></p>
<p>Colors that represent features. You can either use the 20 default
colors or set yours.</p>
</li>
<li><p><strong>stroke_colors</strong>: <em>list</em> of html codes for colors (<em>str</em>)</p>
<p>Colors that represent additional (stroke) features.</p>
colors(if <em>None</em>) or set yours(else).</p>
</li>
</ul>
<ul>
<li><p><strong>shapes</strong>: <em>list</em> of characters (<em>str</em>)</p>
<p>If you use shapes instead of colors, you can either use the default
shapes or set yours. Shapes are Unicode symbols.</p>
Expand All @@ -13225,9 +13224,6 @@ <h3 id="LingMap-Class">LingMap Class<a class="anchor-link" href="#LingMap-Class"
better performance set it to False. More information and examples in
Chapter 2, Paragraph 4.4.</p>
</li>
<li><p><strong>languages_in_popups</strong>: <em>bool</em>, default <em>True</em></p>
<p>Whether to show links to Glottolog website in popups.</p>
</li>
<li><p><strong>control</strong>: <em>bool</em>, default <em>False</em></p>
<p>Whether to add LayerControls and group by features.</p>
</li>
Expand All @@ -13242,8 +13238,7 @@ <h3 id="LingMap-Class">LingMap Class<a class="anchor-link" href="#LingMap-Class"
<p>Colors for the colormap.</p>
</li>
</ul>
<p>\bigskip
<strong>Methods</strong>:</p>
<p><strong>Methods</strong>:</p>
<ul>
<li><p><strong>add_custom_coordinates</strong> <em>(custom_coordinates)</em></p>
<p>Set custom coordinates. By default cooordinates for the languages
Expand All @@ -13256,7 +13251,7 @@ <h3 id="LingMap-Class">LingMap Class<a class="anchor-link" href="#LingMap-Class"
(<em>tuples</em>)</p>
<p>Length of the list should equal to length of languages.</p>
</li>
<li><p><strong>add_features*</strong>(features, radius=7, opacity=1, numeric=False,
<li><p><strong>add_features*</strong>(features, radius=7, opacity=1, colors=None, numeric=False,
control=False, use_shapes=False)*</p>
<p>Add features to the map.</p>
<p><strong>Parameters</strong>:</p>
Expand All @@ -13271,6 +13266,13 @@ <h3 id="LingMap-Class">LingMap Class<a class="anchor-link" href="#LingMap-Class"
<li><p><strong>radius</strong>: <em>int</em>, default <em>7</em></p>
<p>Marker radius.</p>
</li>
<li><p><strong>opacity</strong>: <em>float</em>, default <em>1</em></p>
<p>Marker opacity: a number between 0(invisible) and 1(not transparent).</p>
</li>
<li><p><strong>colors</strong>: <em>list</em> of html codes for colors (<em>str</em>), default <em>None</em></p>
<p>Colors that represent features. You can either use the 20 default
colors(if <em>None</em>) or set yours(else).</p>
</li>
<li><p><strong>numeric</strong>: <em>bool</em>, default <em>False</em></p>
<p>Whether to assign different color to each feature (<em>False</em>), or
to assign a color from colormap (<em>True</em>). You can set it to True
Expand All @@ -13291,7 +13293,7 @@ <h3 id="LingMap-Class">LingMap Class<a class="anchor-link" href="#LingMap-Class"
</li>
</ul>
</li>
<li><p><strong>add_stroke_features*</strong>(features, radius=12, opacity=1,
<li><p><strong>add_stroke_features*</strong>(features, radius=12, opacity=1, colors=None,
numeric=False, control=False)*:</p>
<p>Add additional set of features that look like strokes around
markers.</p>
Expand All @@ -13307,14 +13309,21 @@ <h3 id="LingMap-Class">LingMap Class<a class="anchor-link" href="#LingMap-Class"
<li><p><strong>radius</strong>: <em>int</em>, default <em>12</em></p>
<p>Marker radius. Note that this radius is absolute as well.</p>
</li>
<li><p><strong>opacity</strong>: <em>float</em>, default <em>1</em></p>
<p>Marker opacity: a number between 0(invisible) and 1(not transparent).</p>
</li>
<li><p><strong>colors</strong>: <em>list</em> of html codes for colors (<em>str</em>), default <em>None</em></p>
<p>Colors that represent stroke features. You can either use the 20 default
colors(if <em>None</em>) or set yours(else).</p>
</li>
<li><p><strong>control</strong>: <em>bool</em>, default <em>False</em></p>
<p>Whether to add LayerControls to the map. It allows interactive
turning on/off given stroke features.</p>
</li>
</ul>
</li>
<li><p><strong>add_overlapping_features</strong> <em>(features, radius=7,
radius_increment=4, mapping=None)</em>:</p>
radius_increment=4, colors=None, mapping=None)</em>:</p>
<p>Add overlapping features. For example, if you want to draw on map
whether language 'is ergative', 'is slavic', 'is spoken in Russia'.
It will draw several markers of different size for each feature.</p>
Expand All @@ -13331,13 +13340,17 @@ <h3 id="LingMap-Class">LingMap Class<a class="anchor-link" href="#LingMap-Class"
<p>Step by which the size of the marker for each feature will be
incremented.</p>
</li>
<li><p><strong>colors</strong>: <em>list</em> of html codes for colors (<em>str</em>), default <em>None</em></p>
<p>Colors that represent features. You can either use the 20 default
colors(if <em>None</em>) or set yours(else).</p>
</li>
<li><p><strong>mapping</strong>: <em>dict</em>, default <em>None</em></p>
<p>Mapping for the legend.</p>
</li>
</ul>
</li>
<li><p><strong>add_minicharts</strong> <em>(\</em>minicharts, typ='pie', size=0.6, names=None,
textprops=None, labels=False, colors=[], startangle=90)*:</p>
<li><p><strong>add_minicharts</strong> <em>(&ast;minicharts, typ='pie', size=0.6, names=None,
textprops=None, labels=False, colors=None , startangle=90)</em>:</p>
<p>Create minicharts using Maplotlib.</p>
<p><strong>Parameters</strong>:</p>
<ul>
Expand All @@ -13356,7 +13369,7 @@ <h3 id="LingMap-Class">LingMap Class<a class="anchor-link" href="#LingMap-Class"
<li><p><strong>labels</strong>: <em>bool</em>, default <em>False</em></p>
<p>Whether to display labels.</p>
</li>
<li><p><strong>colors</strong>: <em>list</em>, default <em>[]</em></p>
<li><p><strong>colors</strong>: <em>list</em>, default <em>None</em></p>
<p>Minicharts colors.</p>
</li>
<li><p><strong>startange</strong>: <em>int</em>, default <em>90</em></p>
Expand All @@ -13370,17 +13383,20 @@ <h3 id="LingMap-Class">LingMap Class<a class="anchor-link" href="#LingMap-Class"
<p>Coordinates for the heatmap. To create a heatmap-only map, do not
pass any languages.</p>
</li>
<li><p><strong>add_popups</strong> <em>(popups, parse_html=False)</em></p>
<li><p><strong>add_popups</strong> <em>(popups, parse_html=False, glottolog_links=True)</em></p>
<p>Add popups to markers.</p>
<p><strong>Parameters</strong>:</p>
<ul>
<li><p><strong>popups</strong>: <em>list</em> of strings List of popups. Length of the list
should equal to length of languages.</p>
</li>
<li><p><strong>parse_html</strong>: <em>bool</em>, default <em>False</em> By default (<em>False</em>)
you can add HTML elements. If you need to add full HTML pages to
you can add HTML elements. If you need to add full HTML pages(e.g. with JavaScript code) to
popups, you need to set the option to <em>True</em>.</p>
</li>
<li><p><strong>glottolog_links</strong>: <em>bool</em>, default <em>True</em></p>
<p>Whether to show links to Glottolog website in popups. Automatically disabled when <em>parse_html</em> is used.</p>
</li>
</ul>
</li>
<li><p><strong>add_tooltips</strong> <em>(tooltips)</em>:</p>
Expand Down Expand Up @@ -13447,12 +13463,12 @@ <h3 id="LingMap-Class">LingMap Class<a class="anchor-link" href="#LingMap-Class"
<p>If path is not given <strong>returns</strong> the PNG as <em>bytes</em>.</p>
</li>
</ul>
<h3 id="Functions">Functions<a class="anchor-link" href="#Functions">&#182;</a></h3><p><em>function</em> lingtypology.maps.<strong>merge</strong> <em>(\</em>maps)*</p>
<h3 id="Functions">Functions<a class="anchor-link" href="#Functions">&#182;</a></h3><p><em>function</em> lingtypology.maps.<strong>merge</strong> <em>(&ast;maps)</em></p>
<p>Accepts <em>LingMap</em> objects and creates map of them.</p>
<p>It is impossible to add, for example, features and minicharts. If you
need it, you can create two <em>LingMap</em> objects and then use the <em>merge</em>
function.</p>
<p><strong>Parameter</strong> *maps: <em>lingtypology.maps.LingMap</em> objects.</p>
<p><strong>Parameter</strong> <em>maps: </em>lingtypology.maps.LingMap* objects.</p>
<p><strong>Returns</strong> lingtypology.maps.LingMap</p>
<p><em>function</em> lingtypology.maps.<strong>get_elevations</strong> <em>(languages)</em></p>
<p>Get data on elevation for languages. More information in Chapter 2,
Expand All @@ -13463,7 +13479,8 @@ <h3 id="Functions">Functions<a class="anchor-link" href="#Functions">&#182;</a><
color2='green')</em></p>
<p>Creates color gradient of given length.</p>
<p><strong>Returns</strong> list of HEX-colors</p>
<h2 id="Glottolog">Glottolog<a class="anchor-link" href="#Glottolog">&#182;</a></h2><h3 id="Functions">Functions<a class="anchor-link" href="#Functions">&#182;</a></h3><p>Glottolog module includes various functions to work with Glottolog data.</p>
<h2 id="Glottolog">Glottolog<a class="anchor-link" href="#Glottolog">&#182;</a></h2><p><code>lingtypology.glottolog</code></p>
<h3 id="Functions">Functions<a class="anchor-link" href="#Functions">&#182;</a></h3><p>Glottolog module includes various functions to work with Glottolog data.</p>
<p>The only funcntion that accepts list-like objects and returns <em>list</em> is
<strong>get_affiliations</strong>. Its <strong>parameter</strong> is language names, it
<strong>returns</strong> the genealogical information for the given languages.</p>
Expand Down Expand Up @@ -13521,7 +13538,8 @@ <h3 id="Versions">Versions<a class="anchor-link" href="#Versions">&#182;</a></h3
<li><p>Lingtypology will automatically use the local data.</p>
</li>
</ul>
<h2 id="Databases-API">Databases API<a class="anchor-link" href="#Databases-API">&#182;</a></h2><h3 id="General">General<a class="anchor-link" href="#General">&#182;</a></h3><p>One of the objectives of LingTypology is to provide a simple interface
<h2 id="Databases-API">Databases API<a class="anchor-link" href="#Databases-API">&#182;</a></h2><p><code>lingtypology.datasets</code></p>
<h3 id="General">General<a class="anchor-link" href="#General">&#182;</a></h3><p>One of the objectives of LingTypology is to provide a simple interface
for linguistic databases. Therefore, classes used for acccessing them
have unified API: most attributes and methods overlap among all of them.
In this subsection I will describe this universal interface.</p>
Expand Down Expand Up @@ -13561,28 +13579,28 @@ <h2 id="Databases-API">Databases API<a class="anchor-link" href="#Databases-API"
where keys are headers of the table.</p>
</li>
</ul>
<h3 id="WALS">WALS<a class="anchor-link" href="#WALS">&#182;</a></h3><p><em>class</em> lingtypology.db_apis.<strong>Wals</strong> <em>(\</em>features)*</p>
<p><strong>Parameter</strong> features, <em>list</em></p>
<h3 id="WALS">WALS<a class="anchor-link" href="#WALS">&#182;</a></h3><p><em>class</em> lingtypology.datasets.<strong>Wals</strong> <em>(&ast;features)</em></p>
<p><strong>Parameter</strong> &ast;features, <em>list</em></p>
<p>List of WALS pages that will be present in the resulting table. E.g.
<em>['1A']</em></p>
<p><strong>Additional attribite</strong> general_citation, <em>str</em></p>
<p>The general citation for <strong>all</strong> the WALS pages.</p>
<h3 id="Autotyp">Autotyp<a class="anchor-link" href="#Autotyp">&#182;</a></h3><p><em>class</em> lingtypology.db_apis.<strong>Autotyp</strong> <em>(\</em>tables)*</p>
<p><strong>Parameter</strong> *tables: <em>list</em> of strings</p>
<h3 id="Autotyp">Autotyp<a class="anchor-link" href="#Autotyp">&#182;</a></h3><p><em>class</em> lingtypology.datasets.<strong>Autotyp</strong> <em>(&ast;tables)</em></p>
<p><strong>Parameter</strong> &ast;tables: <em>list</em> of strings</p>
<p>List of the Autoptyp tables that will be merged in the resulting table.
E.g. <em>['gender']</em></p>
<h3 id="AfBo">AfBo<a class="anchor-link" href="#AfBo">&#182;</a></h3><p><em>class</em> lingtypology.db_apis.<strong>AfBo</strong> <em>(\</em>features)*</p>
<p><strong>Parameter</strong> *features: <em>list</em> of strings</p>
<h3 id="AfBo">AfBo<a class="anchor-link" href="#AfBo">&#182;</a></h3><p><em>class</em> lingtypology.datasets.<strong>AfBo</strong> <em>(&ast;features)</em></p>
<p><strong>Parameter</strong> &ast;features: <em>list</em> of strings</p>
<p>List of Autotyp features that will be present in the resulting table.
E.g. <em>['adjectivizer']</em>.</p>
<h3 id="SAILS">SAILS<a class="anchor-link" href="#SAILS">&#182;</a></h3><p><em>class</em> lingtypology.db_apis.<strong>Sails</strong> <em>(\</em>features)*</p>
<p><strong>Parameter</strong> *features: <em>list</em> of strings</p>
<h3 id="SAILS">SAILS<a class="anchor-link" href="#SAILS">&#182;</a></h3><p><em>class</em> lingtypology.datasets.<strong>Sails</strong> <em>(&ast;features)</em></p>
<p><strong>Parameter</strong> &ast;features: <em>list</em> of strings</p>
<p>List of SAILS pages that will be included in the resulting table.</p>
<p><strong>Additional attribute</strong> feature<strong>s</strong>_descriptions: <em>pandas.DataFrame</em></p>
<p>Table that contain description for all the SAILS pages.</p>
<p><strong>Additional method</strong> feature_descriptions <em>(\</em>features)*</p>
<p><strong>Additional method</strong> feature_descriptions <em>(</em>features)*</p>
<p><strong>Returns</strong> table with description for each given <strong>feature</strong>.</p>
<h3 id="PHOIBLE">PHOIBLE<a class="anchor-link" href="#PHOIBLE">&#182;</a></h3><p><em>class</em> lingtypology.db_apis.<strong>Phoible</strong> <em>(subset='all',
<h3 id="PHOIBLE">PHOIBLE<a class="anchor-link" href="#PHOIBLE">&#182;</a></h3><p><em>class</em> lingtypology.datasets.<strong>Phoible</strong> <em>(subset='all',
aggregated=True)</em></p>
<p><strong>Parameters</strong>:</p>
<ul>
Expand Down
Loading

0 comments on commit b89c4f3

Please sign in to comment.