Skip to content

Commit 26d7a47

Browse files
committed
replaced old icon fontawesome aliases w/ generated cvc aliases
1 parent 51483a8 commit 26d7a47

File tree

5 files changed

+118
-96
lines changed

5 files changed

+118
-96
lines changed

docs/_static/css/theme_overrides.css

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ table.docutils th {
1818
}
1919

2020
table.docutils th p {
21-
line-height: 1em !important;
21+
line-height: 1.2em !important;
2222
font-weight: normal !important;
2323
font-size: 1em !important;
2424
font-style: oblique;
@@ -28,3 +28,6 @@ table.docutils th p {
2828
table.docutils td {
2929
padding: 6px 8px !important;
3030
}
31+
table.docutils td p {
32+
line-height: 1.2em !important;
33+
}

docs/model/evidence/direction.rst

Lines changed: 43 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. include:: /generated/civic.docs-aliases.rst
2+
13
.. _evidence-direction:
24

35
Direction
@@ -14,92 +16,100 @@ Evidence Direction interpretation differs slightly depending on the Evidence Typ
1416

1517
.. rubric:: Direction for Predictive Evidence
1618
.. list-table::
17-
:widths: 10 5 85
19+
:widths: 25 5 70
1820
:header-rows: 1
21+
:class: cvc-icon-table
1922

2023
* - Direction
2124
- Symbol
2225
- Definition
2326
* - Supports
24-
- |thumbs-up|
25-
- The experiment or study supports this variants response to a drug
27+
- |attribute-supports|
28+
- Experiment or study supports the variant's response to a drug
2629
* - Does not support
27-
- |thumbs-down|
28-
- The experiment or study does not support, or was inconclusive of an interaction between the variant and a drug
30+
- |attribute-doesnotsupport|
31+
- Experiment or study does not support, or was inconclusive of an interaction between the variant and a drug
2932

3033

3134
.. rubric:: Direction for Diagnostic Evidence
3235
.. list-table::
33-
:widths: 10 5 85
36+
:widths: 25 5 70
3437
:header-rows: 1
38+
:class: cvc-icon-table
3539

3640
* - Direction
3741
- Symbol
3842
- Definition
3943
* - Supports
40-
- |thumbs-up|
41-
- The experiment or study supports variants impact on the diagnosis of disease or subtype
44+
- |attribute-supports|
45+
- Experiment or study supports the variant's impact on the diagnosis of disease or subtype
4246
* - Does not support
43-
- |thumbs-down|
44-
- The experiment or study does not support the variants impact on diagnosis of disease or subtype
47+
- |attribute-doesnotsupport|
48+
- Experiment or study does not support the variant's impact on diagnosis of disease or subtype
4549

4650
.. rubric:: Direction for Prognostic Evidence
4751
.. list-table::
48-
:widths: 10 5 85
52+
:widths: 25 5 70
4953
:header-rows: 1
54+
:class: cvc-icon-table
5055

5156
* - Direction
5257
- Symbol
5358
- Definition
5459
* - Supports
55-
- |thumbs-up|
56-
- The experiment or study supports a variants impact on prognostic outcome
60+
- |attribute-supports|
61+
- Experiment or study supports the variant's impact on prognostic outcome
5762
* - Does not support
58-
- |thumbs-down|
59-
- The experiment or study does not support a prognostic association between variant and outcome
63+
- |attribute-doesnotsupport|
64+
- Experiment or study does not support a prognostic association between variant and outcome
6065

6166
.. rubric:: Direction for Predisposing Evidence (where Significance is Predisposition)
6267
.. list-table::
63-
:widths: 10 5 85
68+
:widths: 25 5 70
6469
:header-rows: 1
70+
:class: cvc-icon-table
6571

6672
* - Direction
6773
- Symbol
6874
- Definition
6975
* - Supports
70-
- |thumbs-up|
71-
- The experiment or study may contribute to a pathogenic classification (final determination at the Assertion level)
76+
- |attribute-supports|
77+
- Suggests a pathogenic or a protective role for a germline variant in cancer
7278
* - Does not support
73-
- |thumbs-down|
74-
- The experiment or study may contribute to a benign classification (final determination at the Assertion level)
79+
- |attribute-doesnotsupport|
80+
- Supports a benign (for Predisposition) or lack of protective (for Protectiveness) role for a germline variant in cancer.
7581

76-
.. rubric:: Direction for Oncogenic Evidence (where Significance is Oncogenicity)
82+
.. rubric:: Direction for Functional Evidence
7783
.. list-table::
78-
:widths: 10 5 85
84+
:widths: 25 5 70
7985
:header-rows: 1
86+
:class: cvc-icon-table
8087

8188
* - Direction
8289
- Symbol
8390
- Definition
8491
* - Supports
85-
- |thumbs-up|
86-
- The experiment or study may contribute to an oncogenic classification (final determination at the Assertion level)
92+
- |attribute-supports|
93+
- Experiment or study supports the variant causing alteration or non-alteration of the gene product function
8794
* - Does not support
88-
- |thumbs-down|
89-
- The experiment or study may contribute to a benign classification (final determination at the Assertion level)
95+
- |attribute-doesnotsupport|
96+
- Experiment or study does not support the variant causing alteration or non-alteration of the gene product function
9097

91-
.. rubric:: Direction for Functional Evidence
98+
.. rubric:: Direction for Oncogenic Evidence (where Significance is Oncogenicity)
9299
.. list-table::
93-
:widths: 10 5 85
100+
:widths: 25 5 70
94101
:header-rows: 1
102+
:class: cvc-icon-table
95103

96104
* - Direction
97105
- Symbol
98106
- Definition
99107
* - Supports
100-
- |thumbs-up|
101-
- The experiment or study supports this variant causing alteration or non-alteration of the gene product function
108+
- |attribute-supports|
109+
- Supports an oncogenic or protective role for a somatic variant.
102110
* - Does not support
103-
- |thumbs-down|
104-
- The experiment or study does not support this variant causing alteration or non-alteration of the gene product function
105-
111+
- |attribute-doesnotsupport|
112+
- Supports a benign (for Oncogenicity) or lack of protective (for Protectiveness) role for a somatic variant in cancer.
113+
* - Not Applicable
114+
- |attribute-na|
115+
- Not applicable for Oncogenic Evidence Type

docs/model/evidence/origin.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. include:: /generated/civic.docs-aliases.rst
2+
13
.. _evidence-origin:
24

35
Origin
@@ -23,27 +25,28 @@ Population frequencies should be based on current population databases (e.g., gn
2325
.. list-table::
2426
:widths: 25 5 70
2527
:header-rows: 1
28+
:class: cvc-icon-table
2629

2730
* - Origin
2831
- Symbol
2932
- Description
3033
* - Somatic
31-
- |ellipsis-h|
34+
- |attribute-somatic|
3235
- Highest priority variants in CIViC. May include presumed somatic variants largely driven by the usage in the original publication but should be approached with caution in instances of tumor-only analysis. Includes fusions.
3336
* - Rare Germline
34-
- |ellipsis-v|
37+
- |attribute-raregermline|
3538
- Consist of heritable rare variants. Generally, <1% of the population relevant to the publication being cited.
3639
* - Common Germline
37-
- |signal|
40+
- |attribute-commongermline|
3841
- Defined as variants with >1% allele frequency in the population relevant to the publication where the evidence is derived. Are welcome in CIViC, however, generally considered low priority for curation efforts.
3942
* - Combined
40-
- ||
43+
- |attribute-combined|
4144
- Variants in the corresponding Complex Molecular Profile have heterogeneous/multiple origins.
4245
* - Unknown
43-
- |question-circle|
46+
- |attribute-unknown|
4447
- May be used in instances where the publication is ambiguous about the origin of the variant although ordinarily an origin would be known (e.g., tumor-only analysis, analyses including both germline and somatic variants).
4548
* - N/A
46-
- |times-circle-o|
49+
- |attribute-na|
4750
- For variants such as 'Expression' where a germline or somatic origin is not applicable.
4851

4952
.. rubric:: Examples
Lines changed: 47 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.. _evidence-significance:
1+
.. include:: /generated/civic.docs-aliases.rst
22

3-
.. include:: /cvc-icon-aliases.rst
3+
.. _evidence-significance:
44

55
Significance
66
============
@@ -13,116 +13,119 @@ The available options for Significance depend on the Evidence Type selected for
1313
.. rubric:: Significance for Predictive Evidence
1414
.. list-table::
1515
:widths: 25 5 70
16-
:header-rows: 0
16+
:header-rows: 1
17+
:class: cvc-icon-table
1718

1819
* - Significance
1920
- Symbol
2021
- Definition
2122
* - Sensitivity/Response
22-
- |benign|
23+
- |attribute-sensitivityresponse|
2324
- Associated with a clinical or preclinical response to treatment
2425
* - Reduced Sensitivity
25-
- |betteroutcome|
26+
- |attribute-reducedsensitivity|
2627
- Response to treatment is lower than seen in other treatment contexts
2728
* - Resistance
28-
- |ban|
29+
- |attribute-resistance|
2930
- Associated with clinical or preclinical resistance to treatment
3031
* - Adverse Response
31-
- |fire|
32+
- |attribute-adverseresponse|
3233
- Associated with an adverse response to drug treatment
3334
* - N/A
34-
- |times-circle-o|
35+
- |attribute-na|
3536
- Variant does not inform clinical interpretation
3637

3738
.. rubric:: Significance for Diagnostic Evidence
3839
.. list-table::
3940
:widths: 25 5 70
4041
:header-rows: 1
42+
:class: cvc-icon-table
4143

4244
* - Significance
4345
- Symbol
4446
- Definition
4547
* - Positive
46-
- |plus-circle|
48+
- |attribute-positive|
4749
- Associated with diagnosis of disease or subtype
4850
* - Negative
49-
- |minus-circle|
51+
- |attribute-negative|
5052
- Associated with lack of disease or subtype
5153

5254
.. rubric:: Significance for Prognostic Evidence
5355
.. list-table::
5456
:widths: 25 5 70
5557
:header-rows: 1
58+
:class: cvc-icon-table
5659

5760
* - Significance
5861
- Symbol
5962
- Definition
6063
* - Better Outcome
61-
- |arrow-circle-up|
64+
- |attribute-betteroutcome|
6265
- Demonstrates better than expected clinical outcome
6366
* - Poor Outcome
64-
- |arrow-circle-down|
67+
- |attribute-pooroutcome|
6568
- Demonstrates worse than expected clinical outcome
6669
* - N/A
67-
- |times-circle-o|
70+
- |attribute-na|
6871
- Variant does not inform clinical action
6972

7073
.. rubric:: Significance for Predisposing Evidence
7174
.. list-table::
7275
:widths: 25 5 70
7376
:header-rows: 1
77+
:class: cvc-icon-table
7478

7579
* - Significance
7680
- Symbol
7781
- Definition
7882
* - Predisposition
79-
- |times-circle-o|
80-
- Evidence may contribute to an interpretation of pathogenic/benign at the assertion level
81-
* - Protectiveness
82-
- |times-circle-o|
83-
- Presence of a germline molecular profile reduces the chance of cancer
84-
85-
.. rubric:: Significance for Oncogenic Evidence
86-
.. list-table::
87-
:widths: 25 5 70
88-
:header-rows: 1
89-
90-
* - Significance
91-
- Symbol
92-
- Definition
93-
* - Oncogenicity
94-
- |times-circle-o|
95-
- Evidence may contributes to an interpretation of oncogenic/benign at the assertion level
83+
- |attribute-predisposition|
84+
- Germline variant has predisposing potential for cancer, and may meet select ACMG/AMP criteria supporting pathogenic or benign classification.
9685
* - Protectiveness
97-
- |times-circle-o|
98-
- Presence of a somatic molecular profile reduces the chance of cancer
99-
86+
- |attribute-protectiveness|
87+
- Germline variant has properties that protect individuals from acquiring cancer.
10088

10189
.. rubric:: Significance for Functional Evidence
10290
.. list-table::
10391
:widths: 25 5 70
10492
:header-rows: 1
93+
:class: cvc-icon-table
10594

10695
* - Significance
10796
- Symbol
10897
- Definition
10998
* - Gain of Function
110-
- |arrow-circle-up|
111-
- A sequence variant whereby enhanced function is conferred on the gene product
99+
- |attribute-gainoffunction|
100+
- Sequence variant confers an increase in normal gene function
112101
* - Loss of Function
113-
- |arrow-circle-down|
114-
- A sequence variant whereby the gene product has diminished or abolished function
102+
- |attribute-lossoffunction|
103+
- Sequence variant confers a diminished or abolished function
115104
* - Unaltered Function
116-
- |arrows-h|
117-
- A sequence variant whereby the function of the gene product is unchanged
105+
- |attribute-unalteredfunction|
106+
- Gene product of sequence variant is unchanged
118107
* - Neomorphic
119-
- |exclamation-circle|
108+
- |attribute-neomorphic|
120109
- Sequence variant creates a novel function
121110
* - Dominant Negative
122-
- |expand|
123-
- Sequence variant abolishes wild type allele function
111+
- |attribute-dominantnegative|
112+
- Sequence variant abrogates function of wildtype allele gene product
124113
* - Unknown
125-
- |sign-out|
126-
- A functional variant that cannot be precisely defined by gain-of-function, loss-of-function, or unaltered function
114+
- |attribute-unknown|
115+
- Sequence variant that cannot be precisely defined by the other listed categories
127116

117+
.. rubric:: Significance for Oncogenic Evidence
118+
.. list-table::
119+
:widths: 25 5 70
120+
:header-rows: 1
121+
:class: cvc-icon-table
128122

123+
* - Significance
124+
- Symbol
125+
- Definition
126+
* - Oncogenicity
127+
- |attribute-oncogenicity|
128+
- Somatic variant has oncogenic potential for driving cancer, and may meet select ClinGen/CGC/VICC criteria supporting pathogenic or benign classification.
129+
* - Protectiveness
130+
- |attribute-protectiveness|
131+
- Somatic variant has a protective role against cancer.

0 commit comments

Comments
 (0)