Specify more precise names for similarities in RDKit
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 45/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- Active
- Domaine
- documentation
Piste de recherche
Start by locating the documentation and API definitions for the Kulczynski, Sokal, AllBit, and Asymmetric similarities, then compare their current labels with the cited literature. Done means the similarity variants are explicitly identified in the documentation and any renames or aliases follow the project's deprecation policy.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Is your feature request related to a problem? Please describe.
There are 2 different Kulczynski similarity measures and at least 7 similarities with "Sokal" in the name. I spent over a week to understand that it uses Kulczynski 2 similarity and Sokal-Sneath 2 similarity. Formulas in the code are not particularly straightforward to translate to the standard literature ones (but I eventually got the proofs right).
Furthermore:
- "AllBit" similarity is the Rand similarity, also known as Sokal-Michener simple matching
- "Asymmetric" similarity is the Simpson similarity, also known as overlap similarity
As far as I can tell, only RDKit uses the former names. I think that common literature names should be used
References:
- "Encyclopedia of Distances" M. Deza, E. Deza
- "A comparison of 71 binary similarity coefficients: The effect of base rates" M. Brusco et al.
- "Similarity Coefficients for Binary Chemoinformatics Data: Overview and Extended Comparison Using Simulated and Real Data Sets" R. Todeschini et al.
- "Distances and Similarity Measures in Chemometrics and Chemoinformatics" R. Todeschini et al.
Describe the solution you'd like
Specify similarity types explicitly in the documentation for Kulczynski and Sokal. Change names of AllBit and Asymmetric to Rand and Simpson similarity, respectively.
Describe alternatives you've considered
If names for AllBit and Asymmetric are not easily changeable with deprecation schedule (though I think they are), more common names should at least be mentioned in the docs.
- Langage dominant
- HTML
- Étoiles
- 3.6k
- Forks
- 1.1k
- Merge moyen
- 4 j 5 h
- PR mergées (30 j)
- 44
Préparer son environnement
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de rdkit/rdkit
-
Difficulté 2/5 1-3 heures Accessibilité débutants 90/100
Les mainteneurs répondent en général sous 1 jour
-
Clarify mol_from_smiles vs qmol_from_smarts for substruct_count queries in Postgresql cartridgeOuverteenhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 86/100
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 4/5 3-5 jours Accessibilité débutants 45/100
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 3/5 1-2 jours Accessibilité débutants 70/100
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 4/5 3-5 jours Accessibilité débutants 65/100
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de rdkit/rdkit
Issues similaires
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
Les mainteneurs répondent en général sous 1 jour
-
documentation good first issue
Difficulté 2/5 1-3 heures Accessibilité débutants 90/100
amponce/archive-movie-browser#340 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 92/100
bytecodealliance/wasmtime#14433 ·
Les mainteneurs répondent en général sous 1 jour
-
documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
antropos17/Aegis#629 ·
Les mainteneurs répondent en général sous 4 jours
-
module-request
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour