Package 'tidyversedashboard'

Title: Tidyverse activity dashboard
Description: A dashboard to show repository activity in tidyverse organisations.
Authors: Jim Hester [aut, cre]
Maintainer: Jim Hester <[email protected]>
License: GPL-3
Version: 0.0.0.9000
Built: 2024-10-26 02:55:12 UTC
Source: https://github.com/ThinkR-open/tidyversedashboard

Help Index


A wrapper around [DT::datatable] to change some defaults

Description

A wrapper around [DT::datatable] to change some defaults

Usage

data_table(
  data,
  options = list(),
  ...,
  filter = "top",
  style = "default",
  autoHideNavigation = TRUE,
  rownames = FALSE,
  escape = FALSE
)

Arguments

data

a data object (either a matrix or a data frame)

options

a list of initialization options (see https://datatables.net/reference/option/); the character options wrapped in JS() will be treated as literal JavaScript code instead of normal character strings; you can also set options globally via options(DT.options = list(...)), and global options will be merged into this options argument if set

...

Other parameters to add to DT::datatable

filter

whether/where to use column filters; none: no filters; bottom/top: put column filters at the bottom/top of the table; range sliders are used to filter numeric/date/time columns, select lists are used for factor columns, and text input boxes are used for character columns; if you want more control over the styles of filters, you can provide a list to this argument of the form list(position = 'top', clear = TRUE, plain = FALSE), where clear indicates whether you want the clear buttons in the input boxes, and plain means if you want to use Bootstrap form styles or plain text input styles for the text input boxes

style

either 'auto', 'default', 'bootstrap', or 'bootstrap4'. If 'auto', and a **bslib** theme is currently active, then bootstrap styling is used in a way that "just works" for the active theme. Otherwise, DataTables 'default' styling is used. If set explicitly to 'bootstrap' or 'bootstrap4', one must take care to ensure Bootstrap's HTML dependencies (as well as Bootswatch themes, if desired) are included on the page. Note, when set explicitly, it's the user's responsibility to ensure that only one unique 'style' value is used on the same page, if multiple DT tables exist, as different styling resources may conflict with each other.

autoHideNavigation

TRUE to automatically hide navigational UI (only display the table body) when the number of total records is less than the page size. Note, it only works on the client-side processing mode and the 'pageLength' option should be provided explicitly.

rownames

TRUE (show row names) or FALSE (hide row names) or a character vector of row names; by default, the row names are displayed in the first column of the table if exist (not NULL)

escape

whether to escape HTML entities in the table: TRUE means to escape the whole table, and FALSE means not to escape it; alternatively, you can specify numeric column indices or column names to indicate which columns to escape, e.g. 1:5 (the first 5 columns), c(1, 3, 4), or c(-1, -3) (all columns except the first and third), or c('Species', 'Sepal.Length'); since the row names take the first column to display, you should add the numeric column indices by one when using rownames


Return the number of development dependencies in a package description file.

Description

Return the number of development dependencies in a package description file.

Usage

desc_dev_deps(description)

desc_maintainer(description)

Arguments

description

A [desc::desc] object.


Get org name

Description

Get org name

Usage

get_org_name(org)

Arguments

org

Org or user login

Value

string

Examples

get_org_name("r-lib")
get_org_name("jimhester")

Return github user name homepage link

Description

Return github user name homepage link

Usage

github_user_home(username)

Arguments

username

github username


Retrieve opened and closed issues and pull requests since a given date

Description

Retrieve opened and closed issues and pull requests since a given date

Usage

issue_progress(
  org,
  start = today() - dweeks(1),
  privacy = c("PUBLIC", "PRIVATE", "BOTH")
)

Arguments

org

A GitHub user, either a normal user or an organization

start

Datetime to start query from

privacy

The repository privacy


Normalize the repository privacy

Description

Normalize the repository privacy

Usage

normalize_privacy(privacy = c("PUBLIC", "PRIVATE", "BOTH"))

Arguments

privacy

repository privacy


Number of downloads from RStudio mirror

Description

Number of downloads from RStudio mirror

Usage

num_downloads(package, when = "last-week")

Arguments

package

One or more packages to search

when

last-day, last-week or last-month (see details). If this is given, then from and to are ignored.


Compute an organization summary

Description

Compute an organization summary

Usage

org_data(org, privacy = c("PUBLIC", "PRIVATE", "BOTH"))

Arguments

org

A GitHub user, either a normal user or an organization

privacy

The repository privacy


Compute an pull request reviewer summary

Description

Compute an pull request reviewer summary

Usage

org_pr(org, privacy = c("PUBLIC", "PRIVATE", "BOTH"))

Arguments

org

A GitHub user, either a normal user or an organization

privacy

The repository privacy


Calculate number or reverse dependencies

Description

Calculate number or reverse dependencies

Usage

reverse_dependencies(package)

Arguments

package

One or more packages to search


Plot a sparkline table

Description

Plot a sparkline table

Usage

sparkline_table(data, sparkline_column, ...)

Arguments

data

a data object (either a matrix or a data frame)

sparkline_column

The column to convert to a sparkline

...

Other parameter to add to DT::datatable


Generate a status badge

Description

Generate a status badge

Usage

github_status_badge(owner, package)

cran_status_badge(package)

coverage_status_badge(owner, package, default = "main")

Arguments

owner

The repository owner

package

The package

default

Main branch of the git repository


Lookup weekly commit counts for each repo

Description

Lookup weekly commit counts for each repo

Usage

weekly_commits(org, package)

Arguments

org

A GitHub user, either a normal user or an organization

package

One or more packages to search