|
1 | | -# CLICS⁴ |
| 1 | +# CLICS 4 |
2 | 2 |
|
3 | 3 | ## How to cite |
4 | 4 |
|
5 | 5 | If you use these data please cite |
6 | 6 | - the original source |
7 | | - > Tjuka, Annika; Forkel, Robert; Rzymski, Christoph; and List, Johann-Mattis (2025): CLICS⁴: An Improved Database of Cross-Linguistic Colexifications [Dataset, Version 0.4]. Passau: MCL Chair at the University of Passau. |
| 7 | + > Tjuka, Annika; Forkel, Robert; Rzymski, Christoph; and List, Johann-Mattis (2025): CLICS 4: An Improved Database of Cross-Linguistic Colexifications [Dataset, Version 0.5]. Passau: MCL Chair at the University of Passau. |
8 | 8 | - the derived dataset using the DOI of the [particular released version](../../releases/) you were using |
9 | 9 |
|
10 | 10 | ## Description |
11 | 11 |
|
12 | 12 |
|
13 | 13 | This dataset is licensed under a CC-BY-4.0 license |
14 | 14 |
|
15 | | -Available online at https://clics.clld.org |
| 15 | +Available online at https://github.com/clics/clics4 |
16 | 16 |
|
17 | 17 | ## Notes |
18 | 18 |
|
19 | | -# CLICS4: Workflow |
| 19 | +# CLICS 4: Workflow for Data Generation |
20 | 20 |
|
21 | | -The CLICS4 workflow differs slightly from the workflow we have used in [CLICS3](https://github.com/clics/clics3). We now have drastically increased the number of datasets, but we have also made sure to use stricter selection criteria for the languages to be included. This also results in different numbers with respect to the number of concepts and the number of language varieties. |
| 21 | +The CLICS 4 workflow differs slightly from the workflow we have used in [CLICS3](https://github.com/clics/clics3). We now have drastically increased the number of datasets, but we have also made sure to use stricter selection criteria for the languages to be included. This also results in different numbers with respect to the number of concepts and the number of language varieties. |
22 | 22 |
|
23 | | -## How to Cite CLICS⁴? |
| 23 | +## How to Cite CLICS 4? |
24 | 24 |
|
25 | | -> Tjuka, Annika; Forkel, Robert; Rzymski, Christoph; and List, Johann-Mattis (2025): CLICS⁴: An Improved Database of Cross-Linguistic Colexifications [Dataset Version 0.4]. Passau: MCL Chair at the University of Passau. |
| 25 | +If you use the data in your work, make sure to cite the correct version that you are using. For the currently most recent version, we recommend to cite it as follows: |
26 | 26 |
|
27 | | -## W1: What is New in Comparison with CLICS³? |
| 27 | +> Tjuka, Annika; Forkel, Robert; Rzymski, Christoph; and List, Johann-Mattis (2025): CLICS 4: An Improved Database of Cross-Linguistic Colexifications [Dataset Version 0.5]. Passau: MCL Chair at the University of Passau. https://github.com/clics/clics4/ |
| 28 | +
|
| 29 | +Since the whole workflow underlying CLICS 4 regardless of the individual versions will be presented in a freely available publication, we also appreciate if you cite this forthcoming paper (already available as preprint): |
| 30 | + |
| 31 | +> Tjuka, Annika; Forkel, Robert; Rzymski, Christoph; and List, Johann-Mattis (forthcoming): Advancing the Database of Cross-Linguistic Colexifications with New Workflows and Data. Proceedings of the 16th International Conference on Computational Semantics (IWCS). Düsseldorf: Association for Computational Linguistics. 1-15. Preprint: https://doi.org/10.48550/arXiv.2503.11377 |
| 32 | +
|
| 33 | +## What is New in Comparison with CLICS³? |
28 | 34 |
|
29 | 35 | The following points summarize major differences between CLICS³ and CLICS⁴: |
30 | 36 |
|
31 | | -- more datasets in CLICS⁴: CLICS⁴ now uses 98 datasets, while CLICS³ used 30 |
32 | | -- fully transcribed data instead of data in orthography: CLICS⁴ now uses data fully transcribed to IPA, ignoring all datasets that only offer orthography (this results in fewer languages at times, despite the increase in datasets) |
33 | | -- |
| 37 | +- more datasets in CLICS 4: CLICS 4 now uses 98 datasets, while CLICS³ used 30 |
| 38 | +- fully transcribed data instead of data in orthography: CLICS 4 now uses data fully transcribed to IPA, ignoring all datasets that only offer orthography (this results in fewer languages at times, despite the increase in datasets) |
| 39 | +- treatment of concepts: we now model some "hidden" colexifications that have been ignored before, since the concept identifiers in Concepticon cover two separate concepts that are frequently colexified as one single concept, as separate concepts (these are marked in the CLDF representation) |
| 40 | +- we provide a full-fledged CLDF dataset now, in which the concept network is also modeled with the help of CLDF |
34 | 41 |
|
| 42 | +## Workflow for Data Aggregation |
35 | 43 |
|
36 | | -## W.1: Install Packages |
| 44 | +In the following, we run those interested in trying the workflow that we applied to construct CLICS 4 on their own machines through the workflow in due detail. To run the workflow, we assume that users have enough experience with Python in order to know how to create their own fresh virtual environment and know how to run commands in the terminal. |
| 45 | + |
| 46 | +### W1: Install Packages |
37 | 47 |
|
38 | 48 | All you need to install the packages required is to install the current package with [PIP](https://pypi.org/project/pip) as follows (using a fresh virtual environment), after having downloaded the `clics4` package with [GIT](https://git-scm.com). The following lines also obtain the version that we used in this demo. |
39 | 49 | ``` |
40 | 50 | $ git clone https://github.com/clics/clics4.git |
41 | 51 | $ cd clics4 |
42 | | -$ git checkout v0.4 |
| 52 | +$ git checkout v0.5 |
43 | 53 | $ pip install -e . |
44 | 54 | ``` |
45 | 55 |
|
46 | 56 | ## W2: Download Data |
47 | 57 |
|
48 | | -In order to do a fresh download of all the data that we use in CLICS⁴, you need to run the following command: |
| 58 | +In order to do a fresh download of all the data that we use in CLICS 4, you need to run the following command: |
49 | 59 |
|
50 | 60 | ``` |
51 | 61 | $ cldfbench download lexibank_clics4.py |
52 | 62 | ``` |
53 | 63 |
|
54 | | -## W3: Create CLICS4 Dataset |
| 64 | +## W3: Create CLICS 4 Dataset |
55 | 65 |
|
56 | 66 | Before you can run the code, you must make sure to have downloaded all data and also obtained actual copies of Glottolog, Concepticon, and CLTS. An easy way to obtain these with the help of `cldfbench` is to run the command `cldfbench catconfig` and follow instructions there. If you use a Windows machine, you will need some additional preparations (see [Snee 2024](https://calc.hypotheses.org/7852)), so we kindly ask you to follow the respective instructions in Snee (2024). |
57 | 67 |
|
58 | 68 | If you have successfully run the `catconfig` subcommand, just type: |
59 | 69 |
|
60 | 70 | ``` |
61 | | -$ cldfbench lexibank.makecldf --glottolog-version=v5.1 --concepticon-version=v3.3.0 --clts-version=v2.3.0 lexibank_clics4.py |
| 71 | +$ cldfbench lexibank.makecldf --glottolog-version=v5.2.1 --concepticon-version=v3.4.0 --clts-version=v2.3.0 lexibank_clics4.py |
62 | 72 | ``` |
63 | 73 |
|
64 | 74 | In the other case, specify the explicit locations of the repositories for Glottolog, Concepticon, and CLTS as follwo. |
65 | 75 |
|
66 | 76 | ``` |
67 | | -cldfbench lexibank.makecldf --glottolog-repos=Path2Glottolog --concepticon-repos=Path2Concepticon --clts-repos=Path2Clics --glottolog-version=v5.1 --concepticon-version=v3.3.0 --clts-version=v2.3.0 lexibank_clics4.py |
| 77 | +cldfbench lexibank.makecldf --glottolog-repos=Path2Glottolog --concepticon-repos=Path2Concepticon --clts-repos=Path2Clics --glottolog-version=v5.2.1 --concepticon-version=v3.4.0 --clts-version=v2.3.0 lexibank_clics4.py |
68 | 78 | ``` |
69 | 79 |
|
70 | | -## W4: What needs to be done before we publish CLICS4 as Version 1.0 |
| 80 | +## W4: CLLD Version of CLICS 4 |
71 | 81 |
|
72 | | -This release is a CLICS⁴ dataset that we consider generally good enough with respect to the data to be used in publications (small errors would always be possible with such large numbers of data aggregated from different sources). However, we emphasize that there are a couple of shortcomings for now that we will try to handle before publishing a new version of CLICS that succeeds the current version 3.0 at https://clics.clld.org. Before publishing this new CLLD version of CLICS⁴, we will implement a new representation of the data in order to adhere to the representation of ParameterNetworks in the new [CLDF specification](https://cldf.clld.org). |
| 82 | +This release is a CLICS 4 dataset that we consider generally good enough with respect to the data to be used in publications (small errors would always be possible with such large numbers of data aggregated from different sources). However, we emphasize that there are a couple of shortcomings for now that we will try to handle before publishing a new web-based version of CLICS that succeeds the current version 3.0 at https://clics.clld.org. Before publishing this new CLLD version of CLICS 4, we will implement a new representation of the data in order to adhere to the representation of ParameterNetworks in the new [CLDF specification](https://cldf.clld.org). |
73 | 83 |
|
74 | 84 |
|
75 | 85 |
|
@@ -112,8 +122,8 @@ This release is a CLICS⁴ dataset that we consider generally good enough with r |
112 | 122 | Name | GitHub user | Description | Role |
113 | 123 | --- | --- | --- | --- |
114 | 124 | Annika Tjuka | @annikatjuka | maintainer | Author |
115 | | -Christoph Rzymski | @chrzyki | maintainer | Author |
116 | 125 | Robert Forkel | @xrotwang | maintainer | Author |
| 126 | +Christoph Rzymski | @chrzyki | maintainer | Author |
117 | 127 | Johann-Mattis List | @LinguList | maintainer | Author |
118 | 128 |
|
119 | 129 |
|
|
0 commit comments