Skip to content
Merged
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
20 changes: 20 additions & 0 deletions docs/articles/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,26 @@ LAST = (p1 + scale_color_observable()) | (p2 + scale_fill_observable())
print(render_png(LAST))
```

### Primer

```python exec="on" session="default" source="above"
LAST = (p1 + scale_color_primer()) | (p2 + scale_fill_primer())
```

```python exec="on" session="default" html="true"
print(render_png(LAST))
```

### Atlassian

```python exec="on" session="default" source="above"
LAST = (p1 + scale_color_atlassian()) | (p2 + scale_fill_atlassian())
```

```python exec="on" session="default" html="true"
print(render_png(LAST))
```

### LocusZoom

```python exec="on" session="default" source="above"
Expand Down
17 changes: 17 additions & 0 deletions docs/reference/atlassian.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Atlassian

::: ggsci.palettes
options:
members:
- pal_atlassian
show_root_heading: true
show_source: false

::: ggsci.scales
options:
members:
- scale_color_atlassian
- scale_colour_atlassian
- scale_fill_atlassian
show_root_heading: true
show_source: false
17 changes: 17 additions & 0 deletions docs/reference/primer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Primer

::: ggsci.palettes
options:
members:
- pal_primer
show_root_heading: true
show_source: false

::: ggsci.scales
options:
members:
- scale_color_primer
- scale_colour_primer
- scale_fill_primer
show_root_heading: true
show_source: false
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ nav:
- UCSCGB: reference/ucscgb.md
- D3: reference/d3.md
- Observable: reference/observable.md
- Primer: reference/primer.md
- Atlassian: reference/atlassian.md
- LocusZoom: reference/locuszoom.md
- IGV: reference/igv.md
- COSMIC: reference/cosmic.md
Expand Down
8 changes: 8 additions & 0 deletions src/ggsci/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
from .examples import example_barplot, example_scatterplot
from .palettes import (
pal_aaas,
pal_atlassian,
pal_bmj,
pal_bs5,
pal_cosmic,
Expand All @@ -22,6 +23,7 @@
pal_nejm,
pal_npg,
pal_observable,
pal_primer,
pal_rickandmorty,
pal_simpsons,
pal_startrek,
Expand All @@ -32,6 +34,7 @@
)
from .scales import (
scale_color_aaas,
scale_color_atlassian,
scale_color_bmj,
scale_color_bs5,
scale_color_cosmic,
Expand All @@ -49,6 +52,7 @@
scale_color_nejm,
scale_color_npg,
scale_color_observable,
scale_color_primer,
scale_color_rickandmorty,
scale_color_simpsons,
scale_color_startrek,
Expand All @@ -57,6 +61,7 @@
scale_color_uchicago,
scale_color_ucscgb,
scale_colour_aaas,
scale_colour_atlassian,
scale_colour_bmj,
scale_colour_bs5,
scale_colour_cosmic,
Expand All @@ -74,6 +79,7 @@
scale_colour_nejm,
scale_colour_npg,
scale_colour_observable,
scale_colour_primer,
scale_colour_rickandmorty,
scale_colour_simpsons,
scale_colour_startrek,
Expand All @@ -82,6 +88,7 @@
scale_colour_uchicago,
scale_colour_ucscgb,
scale_fill_aaas,
scale_fill_atlassian,
scale_fill_bmj,
scale_fill_bs5,
scale_fill_cosmic,
Expand All @@ -99,6 +106,7 @@
scale_fill_nejm,
scale_fill_npg,
scale_fill_observable,
scale_fill_primer,
scale_fill_rickandmorty,
scale_fill_simpsons,
scale_fill_startrek,
Expand Down
33 changes: 33 additions & 0 deletions src/ggsci/data.py
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,39 @@
"#9498A0",
]
},
"primer": {
"mark17": [
"#006EDB",
"#EB670F",
"#DF0C24",
"#179B9B",
"#30A147",
"#894CEB",
"#B88700",
"#CE2C85",
"#856D4C",
"#527A29",
"#D43511",
"#167E53",
"#9D615C",
"#64762D",
"#A830E8",
"#866E04",
"#808FA3",
]
},
"atlassian": {
"categorical8": [
"#4688EC",
"#94C748",
"#C97CF4",
"#FCA700",
"#1558BC",
"#964AC0",
"#42B2D7",
"#E06C00",
]
},
"igv": {
"default": [
"#5050FF",
Expand Down
72 changes: 72 additions & 0 deletions src/ggsci/palettes.py
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,78 @@ def palette_func(n: int) -> Sequence[str]:
return palette_func


def pal_primer(palette: str = "mark17", alpha: float = 1.0) -> PaletteFunc:
"""
Primer design system color palette.

Args:
palette: Palette name. Currently only "mark17" is available.
alpha: Transparency level, between 0 and 1.

Returns:
A callable that takes n and returns a color sequence.

Raises:
ValueError: If the palette name is unknown or alpha is invalid.
"""
if palette not in PALETTES["primer"]:
raise ValueError(f"Unknown Primer palette: {palette}")

if not 0 < alpha <= 1:
raise ValueError("alpha must be in (0, 1]")

colors = PALETTES["primer"][palette]

def palette_func(n: int) -> Sequence[str]:
if n > len(colors):
raise ValueError(
f"Palette '{palette}' has only {len(colors)} colors, "
f"but {n} were requested"
)
selected = colors[:n]
if alpha < 1:
return apply_alpha(selected, alpha)
return selected

return palette_func


def pal_atlassian(palette: str = "categorical8", alpha: float = 1.0) -> PaletteFunc:
"""
Atlassian design system color palette.

Args:
palette: Palette name. Currently only "categorical8" is available.
alpha: Transparency level, between 0 and 1.

Returns:
A callable that takes n and returns a color sequence.

Raises:
ValueError: If the palette name is unknown or alpha is invalid.
"""
if palette not in PALETTES["atlassian"]:
raise ValueError(f"Unknown Atlassian palette: {palette}")

if not 0 < alpha <= 1:
raise ValueError("alpha must be in (0, 1]")

colors = PALETTES["atlassian"][palette]

def palette_func(n: int) -> Sequence[str]:
if n > len(colors):
raise ValueError(
f"Palette '{palette}' has only {len(colors)} colors, "
f"but {n} were requested"
)
selected = colors[:n]
if alpha < 1:
return apply_alpha(selected, alpha)
return selected

return palette_func


def pal_locuszoom(palette: str = "default", alpha: float = 1.0) -> PaletteFunc:
"""
LocusZoom color palette.
Expand Down
84 changes: 84 additions & 0 deletions src/ggsci/scales.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

from .palettes import (
pal_aaas,
pal_atlassian,
pal_bmj,
pal_bs5,
pal_cosmic,
Expand All @@ -27,6 +28,7 @@
pal_nejm,
pal_npg,
pal_observable,
pal_primer,
pal_rickandmorty,
pal_simpsons,
pal_startrek,
Expand Down Expand Up @@ -437,6 +439,86 @@ def __post_init__(self, palette: str, alpha: float) -> None:
setattr(self, "palette", pal_observable(palette, alpha))


@dataclass
class scale_color_primer(scale_discrete):
"""
Primer design system color scale.

Args:
palette: Palette name. Currently only "mark17" is available.
alpha: Transparency level, between 0 and 1.
"""

_aesthetics = ["color"]

palette: InitVar[str] = "mark17"
alpha: InitVar[float] = 1.0

def __post_init__(self, palette: str, alpha: float) -> None:
super().__post_init__()
setattr(self, "palette", pal_primer(palette, alpha))


@dataclass
class scale_fill_primer(scale_discrete):
"""
Primer design system fill scale.

Args:
palette: Palette name. Currently only "mark17" is available.
alpha: Transparency level, between 0 and 1.
"""

_aesthetics = ["fill"]

palette: InitVar[str] = "mark17"
alpha: InitVar[float] = 1.0

def __post_init__(self, palette: str, alpha: float) -> None:
super().__post_init__()
setattr(self, "palette", pal_primer(palette, alpha))


@dataclass
class scale_color_atlassian(scale_discrete):
"""
Atlassian design system color scale.

Args:
palette: Palette name. Currently only "categorical8" is available.
alpha: Transparency level, between 0 and 1.
"""

_aesthetics = ["color"]

palette: InitVar[str] = "categorical8"
alpha: InitVar[float] = 1.0

def __post_init__(self, palette: str, alpha: float) -> None:
super().__post_init__()
setattr(self, "palette", pal_atlassian(palette, alpha))


@dataclass
class scale_fill_atlassian(scale_discrete):
"""
Atlassian design system fill scale.

Args:
palette: Palette name. Currently only "categorical8" is available.
alpha: Transparency level, between 0 and 1.
"""

_aesthetics = ["fill"]

palette: InitVar[str] = "categorical8"
alpha: InitVar[float] = 1.0

def __post_init__(self, palette: str, alpha: float) -> None:
super().__post_init__()
setattr(self, "palette", pal_atlassian(palette, alpha))


@dataclass
class scale_color_locuszoom(scale_discrete):
"""
Expand Down Expand Up @@ -1048,6 +1130,8 @@ def scale_fill_tw3(
scale_colour_rickandmorty = scale_color_rickandmorty
scale_colour_simpsons = scale_color_simpsons
scale_colour_flatui = scale_color_flatui
scale_colour_primer = scale_color_primer
scale_colour_atlassian = scale_color_atlassian
scale_colour_frontiers = scale_color_frontiers
scale_colour_gsea = scale_color_gsea
scale_colour_bs5 = scale_color_bs5
Expand Down
Loading