From b489e34648e3c039f6704999f4f84890313ea489 Mon Sep 17 00:00:00 2001 From: James Stevenson Date: Sat, 30 Mar 2024 20:34:33 -0400 Subject: [PATCH] start to clean up descriptions --- docs/source/index.rst | 6 ++++-- src/metakb/query.py | 8 ++++---- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 69a5be54..39933529 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ Meta-Knowledgebase |version| -========================= +============================ .. image:: https://img.shields.io/pypi/v/metakb.svg :alt: PyPI version @@ -16,7 +16,9 @@ Meta-Knowledgebase |version| :alt: tests status :target: https://github.com/cancervariants/metakb/actions/workflows/checks.yaml -description +The Meta-Knowledgebase leverages the collective knowledge of the disparate existing resources of the cancer genomics community to improve the comprehensiveness of clinical interpretation of genomic variation. It utilizes biomedical concept normalization routines to transform ingested interpretation data into a standardized knowledge model that links evidence items according to + +An ongoing goal will be to provide and improve upon standards and guidelines by which other groups with clinical interpretation data may make it accessible and visible to the public. We have released a preprint discussing our initial harmonization effort and observed disparities in the structure and content of variant interpretations. .. toctree:: :hidden: diff --git a/src/metakb/query.py b/src/metakb/query.py index 2f24d1dd..67d178e8 100644 --- a/src/metakb/query.py +++ b/src/metakb/query.py @@ -67,10 +67,10 @@ def __init__( normalizers: Optional[ViccNormalizers] = None, ) -> None: """Initialize neo4j driver and the VICC normalizers. - :param str uri: address of Neo4j DB - :param Tuple[str, str] credentials: tuple containing username and - password - :param ViccNormalizers normalizers: normalizer collection instance + + :param uri: address of Neo4j DB + :param credentials: tuple containing username and password + :param normalizers: normalizer collection instance """ if normalizers is None: normalizers = ViccNormalizers()