Data

Tools

Indexes

Applications

Experiments

Open Source Science

dverse

Document a Universe of Packages

https://github.com/maurolepore/dverse

Science Score: 36.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
    1 of 2 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.8%) to scientific vocabulary

Keywords

documentation-lool package r r-package rstats universe

Keywords from Contributors

dynamic
Last synced: 6 months ago · JSON representation

Repository

Document a Universe of Packages

Basic Info
Statistics
  • Stars: 7
  • Watchers: 1
  • Forks: 0
  • Open Issues: 6
  • Releases: 3
Topics
documentation-lool package r r-package rstats universe
Created over 1 year ago · Last pushed 7 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%"
)

on_ci <- identical(Sys.getenv("GITHUB_ACTIONS"), "true")
```

# dverse


[![R-CMD-check](https://github.com/maurolepore/dverse/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/maurolepore/dverse/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/maurolepore/dverse/graph/badge.svg)](https://app.codecov.io/gh/maurolepore/dverse)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![CRAN status](https://www.r-pkg.org/badges/version/dverse)](https://CRAN.R-project.org/package=dverse)


The goal of dverse is to document a universe. It creates a data frame containing
the metadata associated with the documentation of a collection of R packages. It
allows for linking topic names to their corresponding documentation online.

If you have a meta-package, dverse helps you to create a comprehensive reference
for its website.

## Installation

Install from CRAN:

``` r
install.packages("dverse")
```

or get a development version from GitHub:

``` r
# install.packages("pak")
pak::pak("maurolepore/dverse")
```

## Motivation

The [Tidyverse](https://www.tidyverse.org/) popularized the idea of a "universe
of packages." The typical universe has a meta-package that centralizes access to
functions and data across all its packages. For example, with `library(tidyverse)` the [tidyverse
meta-package](https://tidyverse.tidyverse.org/) centralizes access to the
functions in [dplyr](https://dplyr.tidyverse.org/),
[ggplot2](https://ggplot2.tidyverse.org/), and several other packages in the
[Tidyverse universe](https://www.tidyverse.org/).

However, meta-packages typically don't centralize documentation. For example,
the tidyverse website only shows the [documentation for the tidyverse meta-package
itself](https://tidyverse.tidyverse.org/reference/index.html) but does not show
the [documentation for dplyr](https://dplyr.tidyverse.org/reference/index.html),
[ggplot2](https://ggplot2.tidyverse.org/reference/index.html), and other packages
in the Tidyverse.

The [dverse](https://maurolepore.github.io/dverse/) package solves this problem.
It creates a data frame containing the metadata associated with the
documentation of any set of packages. This data frame can be easily used to
generate the universe-wide reference for the meta-package website, for example
using [pkgdown](https://pkgdown.r-lib.org/).

## Example

* `document_universe()` creates a data frame with documentation metadata of one or
more packages, i.e. the universe.
* You can then turn the URLs into clickable links with e.g. `knitr::kable()` or
`DT::datatabe()` (which also provides a search box).

```{r}
library(dverse)
# Universe
library(glue)
library(tibble)

packages <- c("glue", "tibble")
template <- "https://{package}.tidyverse.org/reference/{topic}.html"
docs <- document_universe(packages, template)

docs

knitr::kable(tail(docs))
```

Owner

  • Name: Mauro Lepore
  • Login: maurolepore
  • Kind: user
  • Location: Amsterdam, Netherlands
  • Company: https://theiafinance.org/

I solve problems systematically -- with data, research, software, and teaching

GitHub Events

Total
  • Create event: 49
  • Release event: 3
  • Issues event: 29
  • Watch event: 11
  • Delete event: 27
  • Issue comment event: 2
  • Push event: 167
  • Pull request event: 54
Last Year
  • Create event: 49
  • Release event: 3
  • Issues event: 29
  • Watch event: 11
  • Delete event: 27
  • Issue comment event: 2
  • Push event: 167
  • Pull request event: 54

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 111
  • Total Committers: 2
  • Avg Commits per committer: 55.5
  • Development Distribution Score (DDS): 0.009
Past Year
  • Commits: 79
  • Committers: 1
  • Avg Commits per committer: 79.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Mauro Lepore m****e@g****m 110
Lepore L****M@S****U 1
Committer Domains (Top 20 + Academic)
si.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 24
  • Total pull requests: 40
  • Average time to close issues: 7 days
  • Average time to close pull requests: about 2 hours
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.13
  • Average comments per pull request: 0.03
  • Merged pull requests: 36
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 24
  • Pull requests: 40
  • Average time to close issues: 7 days
  • Average time to close pull requests: about 2 hours
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.13
  • Average comments per pull request: 0.03
  • Merged pull requests: 36
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • maurolepore (20)
Pull Request Authors
  • maurolepore (51)
Top Labels
Issue Labels
help wanted (3) bug (3) documentation (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 209 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
  • Total maintainers: 1
cran.r-project.org: dverse

Document a Universe of Packages

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 209 Last month
Rankings
Dependent packages count: 27.8%
Dependent repos count: 34.3%
Average: 49.7%
Downloads: 87.0%
Maintainers (1)
maurolepore@gmail.com
Last synced: 6 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/rhub.yaml actions
  • r-hub/actions/checkout v1 composite
  • r-hub/actions/platform-info v1 composite
  • r-hub/actions/run-check v1 composite
  • r-hub/actions/setup v1 composite
  • r-hub/actions/setup-deps v1 composite
  • r-hub/actions/setup-r v1 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • codecov/codecov-action v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • R >= 4.3 depends
  • cli * imports
  • dplyr * imports
  • glue * imports
  • rlang * imports
  • tibble * imports
  • utils * imports
  • DT * suggests
  • knitr * suggests
  • testthat * suggests
  • withr * suggests