diff --git a/docs/db_apis.html b/docs/db_apis.html index def25ec..c624b58 100644 --- a/docs/db_apis.html +++ b/docs/db_apis.html @@ -13128,7 +13128,7 @@
-

Database APIs

APIs for different linguistic databases can be accessed with lingtypology.db_apis.

+

Databases API

API for different linguistic databases can be accessed with lingtypology.datasets.

@@ -13138,7 +13138,7 @@

Database APIs In [1]:

-
import lingtypology.db_apis
+
import lingtypology.datasets
 
@@ -13166,7 +13166,7 @@

1. General In [2]:

-
from lingtypology.db_apis import Autotyp, Wals, Phoible
+
from lingtypology.datasets import Autotyp, Wals, Phoible
 
@@ -13440,7 +13440,7 @@

1.2. get_df and get_jsonMoran, Steven & McCloy, Daniel (eds.) 2019. PHOIBLE 2.0. Jena: Max Planck Institute for the Science of Human History. -(Available online at http://phoible.org, Accessed on 2019-06-08.) +(Available online at http://phoible.org, Accessed on 2019-06-12.)

@@ -13598,7 +13598,7 @@

1.2. get_df and get_jsonMoran, Steven & McCloy, Daniel (eds.) 2019. PHOIBLE 2.0. Jena: Max Planck Institute for the Science of Human History. -(Available online at http://phoible.org, Accessed on 2019-06-08.) +(Available online at http://phoible.org, Accessed on 2019-06-12.)

@@ -13883,7 +13883,7 @@

1.3. citation In [9]: @@ -14244,7 +14246,7 @@

2. Wals
-

3. Autotyp

It is possible to access Autotyp data (online) using lingtypology.db_apis.

+

3. Autotyp

It is possible to access Autotyp data (online) using lingtypology.datasets.Autotyp.

@@ -14399,8 +14401,10 @@

3. Autotyp @@ -14441,7 +14445,7 @@

4. AfBo In [17]: @@ -14605,7 +14609,7 @@

5. SAILS In [20]: @@ -14963,7 +14967,7 @@

6. Phoible In [25]: @@ -15207,7 +15211,7 @@

6. Phoible Moran, Steven & McCloy, Daniel (eds.) 2019. PHOIBLE 2.0. Jena: Max Planck Institute for the Science of Human History. -(Available online at http://phoible.org, Accessed on 2019-06-08.) +(Available online at http://phoible.org, Accessed on 2019-06-12.) @@ -15365,7 +15369,7 @@

6. Phoible Moran, Steven & McCloy, Daniel (eds.) 2019. PHOIBLE 2.0. Jena: Max Planck Institute for the Science of Human History. -(Available online at http://phoible.org, Accessed on 2019-06-08.) +(Available online at http://phoible.org, Accessed on 2019-06-12.) @@ -15588,7 +15592,7 @@

6. Phoible -
+
@@ -15635,7 +15639,7 @@

6. Phoible Moran, Steven & McCloy, Daniel (eds.) 2019. PHOIBLE 2.0. Jena: Max Planck Institute for the Science of Human History. -(Available online at http://phoible.org, Accessed on 2019-06-08.) +(Available online at http://phoible.org, Accessed on 2019-06-12.) @@ -15850,7 +15854,7 @@

6. Phoible -
+
diff --git a/docs/docs.html b/docs/docs.html index 7baf1ea..58dcca4 100644 --- a/docs/docs.html +++ b/docs/docs.html @@ -13163,9 +13163,9 @@

LingMap Class

start_location: (float, float) or str, default (0, 0)

Coordinates of the start location for the map (latitude, longitude) or a text shortcut. List of available shortcuts: -\"Central Europe\", \"Caucasus\", \"Australia & Oceania\", \"Papua -New Guinea\", \"Africa\", \"Asia\", \"North America\", \"Central -America\", \"South America\".

+"Central Europe", "Caucasus", "Australia & Oceania", "Papua +New Guinea", "Africa", "Asia", "North America", "Central +America", "South America".

  • start_zoom: int, default 2

    Initial zoom level. Bypassed if you are using a shortcut @@ -13205,13 +13205,12 @@

    LingMap ClassStroke legend position. Available values: 'right', 'left', 'top', 'bottom', 'bottomright', 'bottomleft', 'topright', 'topleft'.

  • -
  • colors: list of html codes for colors (str).

    +
  • colors: list of html codes for colors (str), default None

    Colors that represent features. You can either use the 20 default -colors or set yours.

    -
  • -
  • stroke_colors: list of html codes for colors (str)

    -

    Colors that represent additional (stroke) features.

    +colors(if None) or set yours(else).

  • + +
    -

    \bigskip -Methods:

    +

    Methods:

    -
  • add_stroke_features*(features, radius=12, opacity=1, +

  • add_stroke_features*(features, radius=12, opacity=1, colors=None, numeric=False, control=False)*:

    Add additional set of features that look like strokes around markers.

    @@ -13307,6 +13309,13 @@

    LingMap Class

    radius: int, default 12

    Marker radius. Note that this radius is absolute as well.

  • +
  • opacity: float, default 1

    +

    Marker opacity: a number between 0(invisible) and 1(not transparent).

    +
  • +
  • colors: list of html codes for colors (str), default None

    +

    Colors that represent stroke features. You can either use the 20 default +colors(if None) or set yours(else).

    +
  • control: bool, default False

    Whether to add LayerControls to the map. It allows interactive turning on/off given stroke features.

    @@ -13314,7 +13323,7 @@

    LingMap Class

  • add_overlapping_features (features, radius=7, -radius_increment=4, mapping=None):

    +radius_increment=4, colors=None, mapping=None):

    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.

    @@ -13331,13 +13340,17 @@

    LingMap ClassStep by which the size of the marker for each feature will be incremented.

  • +
  • colors: list of html codes for colors (str), default None

    +

    Colors that represent features. You can either use the 20 default +colors(if None) or set yours(else).

    +
  • mapping: dict, default None

    Mapping for the legend.

  • -
  • add_minicharts (\minicharts, typ='pie', size=0.6, names=None, -textprops=None, labels=False, colors=[], startangle=90)*:

    +
  • add_minicharts (*minicharts, typ='pie', size=0.6, names=None, +textprops=None, labels=False, colors=None , startangle=90):

    Create minicharts using Maplotlib.

    Parameters:

    -

    Functions

    function lingtypology.maps.merge (\maps)*

    +

    Functions

    function lingtypology.maps.merge (*maps)

    Accepts LingMap objects and creates map of them.

    It is impossible to add, for example, features and minicharts. If you need it, you can create two LingMap objects and then use the merge function.

    -

    Parameter *maps: lingtypology.maps.LingMap objects.

    +

    Parameter maps: lingtypology.maps.LingMap* objects.

    Returns lingtypology.maps.LingMap

    function lingtypology.maps.get_elevations (languages)

    Get data on elevation for languages. More information in Chapter 2, @@ -13463,7 +13479,8 @@

    Functions< color2='green')

    Creates color gradient of given length.

    Returns list of HEX-colors

    -

    Glottolog

    Functions

    Glottolog module includes various functions to work with Glottolog data.

    +

    Glottolog

    lingtypology.glottolog

    +

    Functions

    Glottolog module includes various functions to work with Glottolog data.

    The only funcntion that accepts list-like objects and returns list is get_affiliations. Its parameter is language names, it returns the genealogical information for the given languages.

    @@ -13521,7 +13538,8 @@

    Versions

    Lingtypology will automatically use the local data.

  • -

    Databases API

    General

    One of the objectives of LingTypology is to provide a simple interface +

    Databases API

    lingtypology.datasets

    +

    General

    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.

    @@ -13561,28 +13579,28 @@

    Databases API -

    WALS

    class lingtypology.db_apis.Wals (\features)*

    -

    Parameter features, list

    +

    WALS

    class lingtypology.datasets.Wals (*features)

    +

    Parameter *features, list

    List of WALS pages that will be present in the resulting table. E.g. ['1A']

    Additional attribite general_citation, str

    The general citation for all the WALS pages.

    -

    Autotyp

    class lingtypology.db_apis.Autotyp (\tables)*

    -

    Parameter *tables: list of strings

    +

    Autotyp

    class lingtypology.datasets.Autotyp (*tables)

    +

    Parameter *tables: list of strings

    List of the Autoptyp tables that will be merged in the resulting table. E.g. ['gender']

    -

    AfBo

    class lingtypology.db_apis.AfBo (\features)*

    -

    Parameter *features: list of strings

    +

    AfBo

    class lingtypology.datasets.AfBo (*features)

    +

    Parameter *features: list of strings

    List of Autotyp features that will be present in the resulting table. E.g. ['adjectivizer'].

    -

    SAILS

    class lingtypology.db_apis.Sails (\features)*

    -

    Parameter *features: list of strings

    +

    SAILS

    class lingtypology.datasets.Sails (*features)

    +

    Parameter *features: list of strings

    List of SAILS pages that will be included in the resulting table.

    Additional attribute features_descriptions: pandas.DataFrame

    Table that contain description for all the SAILS pages.

    -

    Additional method feature_descriptions (\features)*

    +

    Additional method feature_descriptions (features)*

    Returns table with description for each given feature.

    -

    PHOIBLE

    class lingtypology.db_apis.Phoible (subset='all', +

    PHOIBLE

    class lingtypology.datasets.Phoible (subset='all', aggregated=True)

    Parameters: