Research Article |
Corresponding author: Adam Tofilski ( rotofils@cyf-kr.edu.pl ) Academic editor: Pierfilippo Cerretti
© 2018 Adam Tofilski.
This is an open access article distributed under the terms of the Creative Commons Attribution License (CC BY 4.0), which permits unrestricted use, distribution, and reproduction in any medium, provided the original author and source are credited.
Citation:
Tofilski A (2018) DKey software for editing and browsing dichotomous keys. ZooKeys 735: 131-140. https://doi.org/10.3897/zookeys.735.21412
|
Despite advances in computer technology and the increasing availability of multiple-access taxonomic keys, traditional dichotomous keys remain the most often used taxonomic identification tools. On the other hand, there seems to be a lack of an editor of dichotomous keys, which is both freely available and easy to use. The DKey software was developed in order to alleviate this problem. A taxonomic key in text format can be imported to the software in order to edit it. Various editing options are possible, including: moving couplets, removing couplets, combining keys and renumbering keys. The software can output the key either in the traditional text format, ready for publication in a scientific journal, or in hypertext linked format, which makes identification faster and easier, due to the fact that pointers can be clicked in order to move to the next couplet. The DKey software should be useful for both taxonomic experts creating keys and those who use them for identification. The DKey software is freely available and open source.
key, single-access key, software, taxonomic identification of species
The identification of species is often based on dichotomous keys (also called single-access keys or pathway keys) (
Originally, dichotomous keys were constructed by taxonomic experts without any support form computer technology. However, when computers became more widespread, computer programs for the automated construction of taxonomic keys were developed (
Multiple-access keys have many advantages (
The aim of the project was to develop the DKey software, which would assist taxonomists in the preparation of dichotomous identification keys. A taxonomic key in text format can be easily imported to the software in order to edit it. The software can output the key either in traditional text format, ready for publication in a scientific journal, or hypertext linked format, which makes identification faster and easier. The DKey software is freely available and open source.
DKey was developed in the C++ programming language. It is based on the QT framework. At the moment, executables are available for the Windows operating system (http://drawwing.org/dkey). However, users of macOS and Linux can obtain the source code and build executables for their operating system, as QT is a cross-platform framework. In future access to DKey should be equally easy for all three operating systems. The source code of the software can be downloaded from the GitHub (https://github.com/DrawWing/DKey). DKey is open source and it is licensed under GNU General Public License, version 3.
DKey allows for reticulation, which means that a couplet can be reached over more than one path and a single taxon can be associated with more than one endpoint. The only restrictions are that the couplet numbers need to be unique, they need to start with 1, they need to be consecutive, each couplet need to be reached from couplet 1 and it needs to refer either to an existent other couplet or an endpoint. The software does not create the key automatically; it is a responsibility of the taxonomic expert to create couplets and to arrange them in an optimal way. In order to test the software, I have used the existing key to the genera of Agathidinae (Hymenoptera, Braconidae) (
The DKey software has a graphical user interface. In the main window, the taxonomic key is displayed in a table (Fig.
When couplets are inserted, removed, moved or copied, the key is not renumbered automatically and its consecutive numbering can be temporally broken. The user decides when the renumbering occurs. This makes it easier to keep track of changes made. Moreover, the renumbering can take a noticeable time in the case of large keys. The renumbering should be done before the key is exported or displayed in the key browser.
There is a validation tool allowing to find logical errors in the key. Among others it is verified if the couplet numbering is unique and consecutive, if the pointers are valid and if each couplet has at least one reference in other couplets. Moreover, a warning is generated whenever reticulation occurs in the key. The reticulation means that the same endpoint occurs in the key more than once or a single couplet is referred by more than one couplet. A key created with DKey can be saved in a XML file which allows relatively easy import to other software. Moreover, in this format international characters can be safely exchanged between operating systems.
DKey can format the key in various ways. For publication in a scientific journal, the key can be saved in rich text format. On the other hand, for making the key available online, it should be saved in hypertext linked format. In this format, pointers can be clicked in order to move to the next couplet. Moreover, a key browser (Fig.
Identification using a key browser is easier because the user moves from couplet to couplet by clicking a chosen lead. It is also possible to go back to the earlier stages of identification by clicking on the list of steps leading to current couplet. Moreover, the software searches the leads for the keyword “Fig.”, and if found, it looks for the presence of an image file in the same directory. If the image is found, it is displayed in the key browser next to the lead in which it is referenced. This simple mechanism is sufficient for the integration of images into the key; there is no need for a manual linking of images with couplets.
The preparation of a new key can be started from scratch using the “new key” option. Then, the first dummy couplet, which needs to be edited, is created. In order to edit the couplet it should be double clicked. More couplets can be added using the option “insert couplet below” (for details see Suppl. material
Taxonomic keys are often developed by the modification of older keys created by another expert. Therefore, the import of an existing key in text format is an important part of the software. Traditional dichotomous taxonomic keys are usually formatted in a consistent way (
In order to illustrate the import, the key to the genera of Agathidinae (
The DKey software fills the gap for an easy-to-use and free editor of conventional dichotomous taxonomic keys. The main advantage of the DKey software is its wide availability. It can be downloaded free of charge and used by both scientists as well as a wider audience. The price of commercial software, for example Lucid Phoenix (
There were other attempts to develop free and open source software for taxonomic keys. Open Key Editor (
There is also a wide range of freely available software, which can be used for the creation of online identification keys, including: ActKey (
In contrast to other free software, DKey is focused not only on the creation of computer based keys but also provides many editing options, which are not available elsewhere, including: import from text, export to text, combining keys, moving and copying couplets. The DKey software is particularly useful in the case of large taxonomic keys consisting of hundreds or thousands of couplets. Nowadays, the identification of large taxonomic groups involves using many small keys. There are separate keys for families, genera, species groups and species. The smaller keys are easier to manage by the taxonomic experts who created them because their renumbering is less time-consuming. On the other hand, this solution is less user-friendly because the user needs to find the key to the next taxonomic level. DKey can be easily used to combine many smaller keys into one very large one.
Taxonomists are encouraged to publish their datasets and allow others to re-use them in the future (
The DKey software is an easy-to-use and freely available dichotomous taxonomic key editor. It can be used for importing existing keys, editing them and exporting them in various formats. Some of the formats are suitable for publication in scientific journals; others make identification easier and faster. The DKey software should be useful for both taxonomic experts creating keys and those who use them for identification.
I would like to thank Shaun Winterton and Lyubomir Penev for the helpful comments on an earlier version of the manuscript. This study was supported by the Ministry of Science and Higher Education grant number DS-3500.
Video tutorial describing how to build a simple taxonomic key using DKey software
Data type: Multimedia.
Explanation note: Use any video player which supports MP4 format in order to see the tutorial.
Video tutorial describing how to import a taxonomic key to DKey software
Data type: Multimedia.
Explanation note: Use any video player which supports MP4 format in order to see the tutorial.