Merge branch 'dev' of https://github.com/hlasse/TextDescriptives into…

… dev

README.md

@@ -50,4 +50,24 @@ td.extract_df(doc)
 |---:|:--------------------------|------------------------:|-------------------------:|---------------:|----------------:|---------------:|----------------:|-----------------:|----------------:|---------------:|---------------:|-----------------:|----------------------:|-----------------------:|--------:|--------------:|------------------------------:|---------------------:|--------:|------:|---------------:|--------------:|-------------------:|-------------:|----------------------:|---------------------------:|------------------------------:|-----------------------------------:|--------------------------------:|--------------------------------:|--------------------------------:|--------------------------------:|--------------------------------:|---------------------------------:|--------------------------:|--------------------------:|--------------------------:|-------------------------:|:-----------------------|:-----------------------|---------------------------:|--------------------------:|-----------------------------------------:|----------------------------------------:|--------------------:|----------------------:|-------------------:|-----------------------:|-------------------------:|----------------------:|---------------------------:|-----------------------------:|--------------------------:|-----------:|------------------:|---------------------------:|---------------:|--------------:|
 |  0 | The world is changed(...) |                0.633002 |                 0.573323 |       0.097561 |        0.121951 |      0.0731707 |        0.170732 |         0.146341 |        0.195122 |      0.0731707 |      0.0731707 |        0.0487805 |               107.879 |             -0.0485714 | 5.68392 |       3.94286 |                      -2.45429 |            -0.708571 | 12.7143 |   0.4 |             24 |      0.853659 |            2.95122 |           41 |                     0 |                          0 |                             0 |                                  0 |                        0.232258 |                        0.232258 |                               0 |                               0 |                               0 |                                0 |                 0.0580645 |                  0.174194 |                         0 |                        0 | False                  | False                  |                    1.77524 |                  0.553188 |                                 0.457143 |                               0.0722806 |             3.28571 |                     3 |            1.54127 |                      7 |                        6 |               3.09839 |                    1.08571 |                            1 |                  0.368117 |         35 |                23 |                   0.657143 |            121 |             5 |
 
-See [the documentation 
+
+
+
+# 📖 Documentation
+
+TextDescriptives has a detailed documentation as well as a series of Jupyter notebook tutorials.
+All the tutorials are located in the `docs/tutorials` folder and can also be found on the documentation webiste.
+
+
+| Documentation              |                                                                             |
+| -------------------------- | --------------------------------------------------------------------------- |
+| 📚 **[Getting started]**       | Guides and instructions on how to use TextDescriptives and its features.                                |
+| 😎 **[Tutorials]**               | Detailed tutorials on how to make the most of TextDescriptives                        |
+| 📰 **[News and changelog]** | New additions, changes and version history.                                 |
+| 🎛 **[API References]**     | The detailed reference for TextDescriptive's API. Including function documentation |
+
+
+[Tutorials]: https://hlasse.github.io/TextDescriptives/tutorial.html
+[Getting started]: https://hlasse.github.io/TextDescriptives/usingthepackage.html
+[API References]: https://hlasse.github.io/TextDescriptives/index.html
+[News and changelog]: https://hlasse.github.io/TextDescriptives/news.html

docs/coherence.rst

@@ -26,6 +26,7 @@ The following attributes are added to :code:`Doc` objects.:
   second order coherence (keys: "first_order_coherence", "second_order_coherence")
 
 [1] Bedi, G., Carrillo, F., Cecchi, G. A., Slezak, D. F., Sigman, M., Mota, N. B., Ribeiro, S., Javitt, D. C., Copelli, M., & Corcoran, C. M. (2015). Automated analysis of free speech predicts psychosis onset in high-risk youths. Npj Schizophrenia, 1(1), Article 1. https://doi.org/10.1038/npjschz.2015.30
+
 [2] Parola, A., Lin, J. M., Simonsen, A., Bliksted, V., Zhou, Y., Wang, H., Inoue, L., Koelkebeck, K., & Fusaroli, R. (2022). Speech disturbances in schizophrenia: Assessing cross-linguistic generalizability of NLP automated measures of coherence. Schizophrenia Research. https://doi.org/10.1016/j.schres.2022.07.002
 
 

docs/index.rst

@@ -38,13 +38,14 @@ please use the discussion Forums.
 .. _GitHub Discussions: https://github.com/HLasse/TextDescriptives/discussions
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Getting Started
    :hidden:
 
    installation
    usingthepackage
    tutorial
+   news
    faq
 
 .. toctree::

docs/installation.rst

@@ -1,11 +1,11 @@
 Installation
 ==================
-To get started using TextDescriptives you can install it using pip by running the following line in your terminal:
+To get started using TextDescriptives you can install it using pip by running the following line in your terminal. Optional dependendices for running the tutorials, buildings docs, running tests, or linting can be installed using the optional dependencies. 
 
 .. code-block::
 
    pip install textdescriptives
-
+   pip install "textdescriptives[style,tests,docs,tutorials]"
 
 Installing from source
 ^^^^^^^^^^^^^^^^^^^^^^^^^

docs/news.rst

@@ -0,0 +1,16 @@
+News and Changelog
+---------------------------------
+
+**v2.0.0 - X 2022**
+- All components have been renamed to have the :code:`textdescriptives/` prefix. I.e. components should now be loaded with e.g. :code:`nlp.add_pipe("textdescriptives/descriptive_stats)`.
+:code:`textdescriptives/all` can be used to load all components at once. 
+- :code:`pos_stats` has been renamed to :code:`pos_proportions` for consistency.
+
+**v1.1.0 - 21st of September, 2022**
+- Added the new pipe; "quality". This pipe implements a series of metrics related to text quality, some of which were used by Rae et al. (2021) and Raffel et al. (2020) to filter large text corpora. See the documentation for examples.
+
+**v1.0.7 - 4th May, 2022**
+- Some minor fixes and bells and whistles.
+
+**v1.0.5 - 4th October, 2021**
+- POS proportions now use :code:`pos_` instead of :code:`tag_` by default. This behavior can be changed by setting `use_tag` to `False` when initialising the `pos_stats` module. 

docs/tutorial.rst

@@ -6,7 +6,7 @@ listed below. Each tutorial is also a Jupyter notebook which you can download an
 locally.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Tutorials
 
    tutorials/introductory_tutorial.ipynb