Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: added FAQ page #287

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions web/src/main/javascript/docs/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Frequently Asked Questions (FAQ)

## 1. Why do you distinguish between “detailed tumor types” and “main tumor types,” and why are the main tumor types not entered into the OncoTree with separate nodes?

OncoTree distinguishes between **detailed tumor types** and **main tumor types** to maintain a structured hierarchy of cancer classifications. The **detailed tumor types** provide specific subcategories within each **main tumor type**, allowing for more precise annotation and analysis. The **main tumor types** act as broader categories that group together related detailed tumor types.

The reason main tumor types are not assigned separate nodes in OncoTree is that the classification is designed to focus on specific, well-defined tumor subtypes rather than broad categories. This ensures that OncoTree remains granular and clinically relevant for precision medicine applications.

## 2. Do you have codes for the main tumor types, just like for the detailed tumor types? Or are you planning on assigning them in the future?

Currently, OncoTree provides unique codes primarily for **detailed tumor types** to facilitate precise classification. While main tumor types do not have distinct codes assigned in the same way, efforts to develop mappings or codes for these broad categories may be considered in the future to improve interoperability with other classification systems.

## 3. Why do you include so many main tumor types with the extension “, NOS”? These types are not included in the drop-down menu for the tumor types on the OncoKB website. Would it make a difference to the results when using these NOS terms as input to the web API?

The extension **"NOS" (Not Otherwise Specified)** is used to indicate tumor types that do not have a more specific classification. These are included to ensure compatibility with clinical terminology and pathology reports, which often use NOS when further molecular or histopathological details are unavailable.

Since OncoKB is optimized for precision oncology, the **NOS terms** may not appear in the drop-down menu because they are considered less specific. However, using NOS terms as input to the **OncoKB web API** could still yield results, depending on whether the system can map them to a more specific classification.

## 4. Do you have a mapping of the main tumor types onto NCI or UMLS as for the detailed tumor types?

Yes, OncoTree provides **detailed tumor type mappings** to external ontologies such as:

- **NCI Thesaurus (NCIt)**
- **Unified Medical Language System (UMLS)**

However, mappings for **main tumor types** may not be explicitly provided. Users may need to rely on hierarchical relationships within OncoTree or external classification resources to infer these mappings.

## 5. Do you have a mapping for the tumor types onto the common SNOMED or ICD-10 codes? Or do you have a suggestion on how to perform this mapping?

OncoTree does not currently provide **direct mappings to SNOMED CT or ICD-10**. However, mappings can be established using:

- **NCI Thesaurus (NCIt)**, which provides cross-references to SNOMED and ICD-10.
- **UMLS Metathesaurus**, which links medical terms across multiple ontologies, including SNOMED and ICD-10.

To perform this mapping, you can:

1. Use **NCIt codes** from OncoTree and find their corresponding entries in SNOMED or ICD-10.
2. Use the **UMLS Metathesaurus API** to look up terms and find equivalent SNOMED/ICD-10 codes.
3. Leverage tools like the **National Library of Medicine (NLM) mappings** to find equivalent ICD-10 codes.
2 changes: 1 addition & 1 deletion web/src/main/javascript/public/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
</head>
<body>
<div id="app"></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"about.md\":\"BceXjb0R\",\"mapping.md\":\"CdddfsKe\",\"news.md\":\"ZGge0dYE\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"OncoTree\",\"description\":\"OncoTree, an open-source cancer classification system, to address fast-evolving needs in clinical reporting of genomic sequencing results and associated oncology research.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"siteTitle\":false,\"aside\":\"left\"},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"about.md\":\"BceXjb0R\",\"faq.md\":\"DLit2BmC\",\"mapping.md\":\"CdddfsKe\",\"news.md\":\"ZGge0dYE\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"OncoTree\",\"description\":\"OncoTree, an open-source cancer classification system, to address fast-evolving needs in clinical reporting of genomic sequencing results and associated oncology research.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"siteTitle\":false,\"aside\":\"left\"},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>

</body>
</html>
2 changes: 1 addition & 1 deletion web/src/main/javascript/public/about.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
</head>
<body>
<div id="app"><div class="Layout" data-v-5d98c3a5><!--[--><!--]--><!--[--><span tabindex="-1" data-v-0f60ec36></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0f60ec36> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5d98c3a5 data-v-ae24b3ad><div class="VPNavBar top" data-v-ae24b3ad data-v-6aa21345><div class="wrapper" data-v-6aa21345><div class="container" data-v-6aa21345><div class="title" data-v-6aa21345><div class="VPNavBarTitle" data-v-6aa21345 data-v-ab179fa1><a class="title" href="/" data-v-ab179fa1><!--[--><!--]--><!----><!----><!--[--><!--]--></a></div></div><div class="content" data-v-6aa21345><div class="content-body" data-v-6aa21345><!--[--><!--]--><div class="VPNavBarSearch search" data-v-6aa21345><!----></div><!----><!----><div class="VPNavBarAppearance appearance" data-v-6aa21345 data-v-6c893767><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-6c893767 data-v-5337faa4 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-5337faa4></span><span class="vpi-moon moon" data-v-5337faa4></span><!--]--></span></span></button></div><!----><div class="VPFlyout VPNavBarExtra extra" data-v-6aa21345 data-v-bb2aa2f0 data-v-b6c34ac9><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-b6c34ac9><span class="vpi-more-horizontal icon" data-v-b6c34ac9></span></button><div class="menu" data-v-b6c34ac9><div class="VPMenu" data-v-b6c34ac9 data-v-b98bc113><!----><!--[--><!--[--><!----><div class="group" data-v-bb2aa2f0><div class="item appearance" data-v-bb2aa2f0><p class="label" data-v-bb2aa2f0>Appearance</p><div class="appearance-action" data-v-bb2aa2f0><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-bb2aa2f0 data-v-5337faa4 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-5337faa4></span><span class="vpi-moon moon" data-v-5337faa4></span><!--]--></span></span></button></div></div></div><!----><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-6aa21345 data-v-e5dd9c1c><span class="container" data-v-e5dd9c1c><span class="top" data-v-e5dd9c1c></span><span class="middle" data-v-e5dd9c1c></span><span class="bottom" data-v-e5dd9c1c></span></span></button></div></div></div></div><div class="divider" data-v-6aa21345><div class="divider-line" data-v-6aa21345></div></div></div><!----></header><div class="VPLocalNav empty fixed" data-v-5d98c3a5 data-v-a6f0e41e><div class="container" data-v-a6f0e41e><!----><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-a6f0e41e data-v-17a5e62e><button data-v-17a5e62e>Return to top</button><!----></div></div></div><!----><div class="VPContent" id="VPContent" data-v-5d98c3a5 data-v-1428d186><div class="VPDoc has-aside" data-v-1428d186 data-v-39a288b8><!--[--><!--]--><div class="container" data-v-39a288b8><div class="left-aside aside" data-v-39a288b8><div class="aside-curtain" data-v-39a288b8></div><div class="aside-container" data-v-39a288b8><div class="aside-content" data-v-39a288b8><div class="VPDocAside" data-v-39a288b8 data-v-3f215769><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-3f215769 data-v-a5bbad30><div class="content" data-v-a5bbad30><div class="outline-marker" data-v-a5bbad30></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-a5bbad30>On this page</div><ul class="VPDocOutlineItem root" data-v-a5bbad30 data-v-b933a997><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-3f215769></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-39a288b8><div class="content-container" data-v-39a288b8><!--[--><!--]--><main class="main" data-v-39a288b8><div style="position:relative;" class="vp-doc _about" data-v-39a288b8><div><h1 id="about" tabindex="-1">About <a class="header-anchor" href="#about" aria-label="Permalink to &quot;About&quot;">​</a></h1><h2 id="about-oncotree" tabindex="-1">About OncoTree <a class="header-anchor" href="#about-oncotree" aria-label="Permalink to &quot;About OncoTree&quot;">​</a></h2><p>OncoTree is a comprehensive, community-led cancer classification system that adapts to the evolving demands of precision oncology. Designed to classify cancers by both histological and molecular traits, it provides a structured framework to complement the clinical decision-making processes. The platform, which is open-source and publicly accessible, is governed by a diverse committee of oncologists, pathologists, and scientists. This multidisciplinary oversight ensures OncoTree remains relevant, incorporating new cancer types and research advancements in real time to support clinical decision-making and research applications.</p><h2 id="curation-process-overview" tabindex="-1">Curation Process Overview <a class="header-anchor" href="#curation-process-overview" aria-label="Permalink to &quot;Curation Process Overview&quot;">​</a></h2><p><img src="/assets/curation_process.CwbRUQ02.png" alt="Overview of the curation process in OncoTree" class="curation-process-overview-image"></p><h2 id="useful-links" tabindex="-1">Useful Links <a class="header-anchor" href="#useful-links" aria-label="Permalink to &quot;Useful Links&quot;">​</a></h2><ul><li>Please send any feedback or questions to the <a href="https://groups.google.com/g/oncotree-users" target="_blank" rel="noreferrer">OncoTree Users Google Group</a>.</li><li>When using OncoTree, please cite: <a href="https://ascopubs.org/doi/10.1200/CCI.20.00108" target="_blank" rel="noreferrer">Kundra et al., JCO Clinical Cancer Informatics 2021</a>.</li></ul></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-e257564d><!--[--><!--]--><!----><!----></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"about.md\":\"BceXjb0R\",\"mapping.md\":\"CdddfsKe\",\"news.md\":\"ZGge0dYE\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"OncoTree\",\"description\":\"OncoTree, an open-source cancer classification system, to address fast-evolving needs in clinical reporting of genomic sequencing results and associated oncology research.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"siteTitle\":false,\"aside\":\"left\"},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"about.md\":\"BceXjb0R\",\"faq.md\":\"DLit2BmC\",\"mapping.md\":\"CdddfsKe\",\"news.md\":\"ZGge0dYE\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"OncoTree\",\"description\":\"OncoTree, an open-source cancer classification system, to address fast-evolving needs in clinical reporting of genomic sequencing results and associated oncology research.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"siteTitle\":false,\"aside\":\"left\"},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>

</body>
</html>
1 change: 1 addition & 0 deletions web/src/main/javascript/public/assets/faq.md.DLit2BmC.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading