The Allele Registry is a service being developed by the ClinGenDB group under the direction of Aleksandar Milosavljevic, PhD at the Baylor College of Medicine. It is the first project within the ClinGen ecosystem to implement a service on the work produced by the ClinGen Data Modeling WG, specifically the Allele Model v0.1(beta). In actuality, this project will serve as the reference implementation of the Allele model, and as such, the model will remain in "beta" until the project is released for use.
Knowledge Curation Requirement
The Allele Registry is being developed initially to support the needs of the Sequence Variant Curation project being developed by the ClinGen group under the direction of J. Michael Cherry, PhD at the Cherry Lab, Stanford University. In addition to the Sequence Variant Curation application, this group is also developing ClinGen applications for Gene Curation, Structural Variant Curation and Actionability Curation. The Sequence Variant Curation application is the first project to progress to a point where it requires a service to lookup and register sequence variant representations found by curators during the process of curating literature containing citable evidence to support the downstream process of developing a system to enable clinical domain expert groups to sign off on variant-disease assertions using evidence from all available sources in the community not the least of which is contained in unstructured publications. This expert based clinical assertion process is a core component in the roadmap to achieving the goals of ClinGen.
What is the ClinGenDB Infrastructure?
The allele registry is planned for implementation within the ClinGenDB using the Genboree infrastructure. The Baylor development team is working with the DMWG Allele model to establish the document models needed to support the five resources; CanonicalAllele, ContextualAllele, ReferenceSequence, Gene, and Provenance.
ClinGenDB may be considered a specialized version of the Genboree infrastructure. Specialized infrastructure has been developed on top of Genboree to create ClinGenDB. The Baylor team has documentation on the ClinGenDB Infrastructure available in the internal ClinGen Confluence Site. If you are interested in further details, please contact email@example.com. For a general technical details on the Genboree infrastructure please refer to the Genboree site.
The Allele Registry has not been released at this time. The current development environment is very active and may deviate from the documented model until such time as the we approach a stable release where we can synchronize both the Allele Model and Allele Registry documentation notes.
The gain access to the preliminary Allele Models in the ClinGenDB development environment, complete the steps below:
- Establish Genboree credentials (user name and password) at http://genboree.org/java-bin/regform.jsp. This is the Genboree central login management system.
- Using the credentials from step 1, login to http://genboree.org/genboreeKB/login and logout. This establishes a resource needed by ClinGenDB.
- After completing steps 1 and 2, send the email address used for registration in step 1 to Ronak.Patel@bcm.edu. Indicate your involvement with ClinGenDB in your email request and use the subject line "Requesting access to Allele Model".
Exploring the Allele Model in ClinGenDB
The following is an informal set of internal instructions and links for members of the DMWG team to begin exploring the Allele Model that is under preliminary development in ClinGenDB. The information is provided here for convenience to those members and users that wish to have preliminary access. It is our intention to update this documentation after the Allele Registry is released or after any significant development occur which may impact the instructions below.
There are four resource document models: Gene, ReferenceSequence, ContextualAllele and CanonicalAllele uploaded into <genboree.org/genboreKB/>. Please note that the official Allele Registry is planned to be hosted on
, with similar structure, for 24x7 accessibility. With your login and passwd, you should be able to see <http://genboree.org/genboreeKB/genboree_kbs?project_id=allelemodels>. If not please let me know.
The redmine project where all the four collections are hosted can be found here.
To go to four collections corresponding to four resources, use these links
Alternatively, collections can be accessed/switched using the pull down menu on left.
Initially, the following subset of Allele Model Examples have been created in these collections
The Collection are in genbKB: alleleModels3 genbgroup: myScratchForGenbreeKB.
This information should be sufficient to use scripts in https://github.com/clinvar/apidemo/ for accessing documents through API. Please also see documents in NCBI confluence for ClinGenDB introduction.