Data

Tools

Indexes

Applications

Experiments

Open Source Science

marquee

Markdown Parser and Renderer for R Graphics

https://github.com/r-lib/marquee

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.7%) to scientific vocabulary

Keywords from Contributors

visualisation ggplot-extension
Last synced: 10 months ago · JSON representation

Repository

Markdown Parser and Renderer for R Graphics

Basic Info
Statistics
  • Stars: 95
  • Watchers: 5
  • Forks: 5
  • Open Issues: 11
  • Releases: 5
Created over 2 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog License Code of conduct

README.Rmd 

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%",
  dev = "ragg_png",
  dpi = 300
)
```

# marquee 


[![R-CMD-check](https://github.com/r-lib/marquee/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/marquee/actions/workflows/R-CMD-check.yaml)
[![CRAN status](https://www.r-pkg.org/badges/version-last-release/marquee)](https://CRAN.R-project.org/package=marquee)
[![Codecov test coverage](https://codecov.io/gh/r-lib/marquee/graph/badge.svg)](https://app.codecov.io/gh/r-lib/marquee)


marquee is a markdown parser and renderer for the R graphics engine. It can be
used to render rich text formatted as markdown (CommonMark) inside R graphics
such as ggplot2 or other graphics built on grid.

## Installation

``` r
# You can install marquee from CRAN
install.packages("marquee")

# Or get the development version from Github using pak
pak::pak("r-lib/marquee")
```

## Examples

The main function of the package is `marquee_grob()` which creates a grob based
on markdown text and a style that can be rendered with grid:

```{r, fig.asp=2}
# Let's render this readme
readme <- paste(readLines("README.Rmd")[-seq_len(17)], collapse = "\n")

library(marquee)
library(grid)

fancy_style <- classic_style(
  body_font = "baskerville",
  header_font = "marker felt",
  code_font = "fira code"
) |>
  modify_style("cb", background = linearGradient(
    colours = c("lightblue", "white"),
    x1 = 0, y1 = 1, x2 = 0, y2 = 0
  ))
grob <- marquee_grob(readme, style = fancy_style)
grid.draw(grob)
```

(*The above is an image – go ahead and check*)

## Prior art

I would be remiss to not mention [gridtext](https://github.com/wilkelab/gridtext)
and [ggtext](https://github.com/wilkelab/ggtext), both by Claus Wilke. These
packages aim to solve much the same problem as marquee, but work in a different way
and don't have the same powerful textshaping backend as marquee. Most notably from
a user perspective is perhaps that gridtext understands HTML to some degree,
whereas marquee is oblivious to both HTML and CSS. Instead, it supports the [full
CommonMark spec](https://spec.commonmark.org/) with the plan to add support for
custom span elements as well.

Owner

  • Name: R infrastructure
  • Login: r-lib
  • Kind: organization

GitHub Events

Total
  • Create event: 4
  • Commit comment event: 1
  • Release event: 4
  • Issues event: 66
  • Watch event: 11
  • Delete event: 1
  • Issue comment event: 84
  • Push event: 72
  • Pull request event: 9
  • Fork event: 2
Last Year
  • Create event: 4
  • Commit comment event: 1
  • Release event: 4
  • Issues event: 66
  • Watch event: 11
  • Delete event: 1
  • Issue comment event: 84
  • Push event: 72
  • Pull request event: 9
  • Fork event: 2

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 147
  • Total Committers: 4
  • Avg Commits per committer: 36.75
  • Development Distribution Score (DDS): 0.041
Past Year
  • Commits: 59
  • Committers: 4
  • Avg Commits per committer: 14.75
  • Development Distribution Score (DDS): 0.085
Top Committers
Name Email Commits
Thomas Lin Pedersen t****5@g****m 141
Teun van den Brand 4****d 4
Salim B g****b@s****e 1
Enrico Spinielli e****i@g****m 1
Committer Domains (Top 20 + Academic)
salim.space: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 63
  • Total pull requests: 14
  • Average time to close issues: 26 days
  • Average time to close pull requests: 9 days
  • Total issue authors: 31
  • Total pull request authors: 4
  • Average comments per issue: 0.6
  • Average comments per pull request: 1.79
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 45
  • Pull requests: 9
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 14 days
  • Issue authors: 25
  • Pull request authors: 3
  • Average comments per issue: 0.47
  • Average comments per pull request: 1.78
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • thomasp85 (10)
  • jmw86069 (6)
  • teunbrand (5)
  • xtimbeau (5)
  • alejandrohagan (4)
  • davidhodge931 (4)
  • petermott (3)
  • fmarotta (2)
  • trevorld (2)
  • JDenn0514 (1)
  • petrbouchal (1)
  • jack-davison (1)
  • psoldath (1)
  • markheckmann (1)
  • steveharoz (1)
Pull Request Authors
  • teunbrand (7)
  • thomasp85 (3)
  • salim-b (2)
  • espinielli (2)
Top Labels
Issue Labels
upkeep (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 683 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 1
cran.r-project.org: marquee

Markdown Parser and Renderer for R Graphics

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 683 Last month
Rankings
Dependent packages count: 28.8%
Dependent repos count: 35.5%
Average: 49.8%
Downloads: 85.2%
Maintainers (1)
thomas.pedersen@posit.co
Last synced: 10 months ago

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.5.0 composite
  • actions/checkout v4 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pr-commands.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/pr-fetch v2 composite
  • r-lib/actions/pr-push v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • cli * imports
  • grid * imports
  • jpeg * imports
  • png * imports
  • rlang >= 1.1.0 imports
  • systemfonts * imports
  • textshaping * imports
  • ggplot2 * suggests
  • patchwork * suggests
  • rsvg * suggests