Skip to content

Commit

Permalink
readme updates (#191)
Browse files Browse the repository at this point in the history
Related to
insightsengineering/coredev-tasks#462

---------

Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>
  • Loading branch information
m7pr and dependabot-preview[bot] authored Sep 14, 2023
1 parent 9e84d07 commit 3428dde
Show file tree
Hide file tree
Showing 10 changed files with 50 additions and 20 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
LICENSE
^renv$
^renv\.lock$
CODE_OF_CONDUCT.md
Expand Down
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ The package maintainer also reserves the right to adjust the criteria to recogni
If you have further questions regarding the contribution guidelines, please contact the package/repository maintainer.

<!-- urls -->
[docs]: https://insightsengineering.github.io/teal.widgets/index.html
[articles]: https://insightsengineering.github.io/teal.widgets/main/articles/index.html
[license]: https://insightsengineering.github.io/teal.widgets/main/LICENSE-text.html
[docs]: https://insightsengineering.github.io/teal.widgets/latest-tag/index.html
[articles]: https://insightsengineering.github.io/teal.widgets/latest-tag/articles/index.html
[license]: https://insightsengineering.github.io/teal.widgets/latest-tag/LICENSE-text.html
[insights]: https://github.com/insightsengineering/teal.widgets/pulse
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ body:
id: code-of-conduct
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct.](https://insightsengineering.github.io/teal.widgets/CODE_OF_CONDUCT.html)
description: By submitting this issue, you agree to follow our [Code of Conduct.](https://insightsengineering.github.io/teal.widgets/latest-tag/CODE_OF_CONDUCT.html)
options:
- label: I agree to follow this project's Code of Conduct.
required: true
- type: checkboxes
id: contributor-guidelines
attributes:
label: Contribution Guidelines
description: By submitting this issue, you agree to follow our [Contribution Guidelines.](https://insightsengineering.github.io/teal.widgets/CONTRIBUTING.html)
description: By submitting this issue, you agree to follow our [Contribution Guidelines.](https://insightsengineering.github.io/teal.widgets/latest-tag/CONTRIBUTING.html)
options:
- label: I agree to follow this project's Contribution Guidelines.
required: true
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ body:
id: code-of-conduct
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct.](https://insightsengineering.github.io/teal.widgets/CODE_OF_CONDUCT.html)
description: By submitting this issue, you agree to follow our [Code of Conduct.](https://insightsengineering.github.io/teal.widgets/latest-tag/CODE_OF_CONDUCT.html)
options:
- label: I agree to follow this project's Code of Conduct.
required: true
- type: checkboxes
id: contributor-guidelines
attributes:
label: Contribution Guidelines
description: By submitting this issue, you agree to follow our [Contribution Guidelines.](https://insightsengineering.github.io/teal.widgets/CONTRIBUTING.html)
description: By submitting this issue, you agree to follow our [Contribution Guidelines.](https://insightsengineering.github.io/teal.widgets/latest-tag/CONTRIBUTING.html)
options:
- label: I agree to follow this project's Contribution Guidelines.
required: true
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ body:
id: code-of-conduct
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct.](https://insightsengineering.github.io/teal.widgets/CODE_OF_CONDUCT.html)
description: By submitting this issue, you agree to follow our [Code of Conduct.](https://insightsengineering.github.io/teal.widgets/latest-tag/CODE_OF_CONDUCT.html)
options:
- label: I agree to follow this project's Code of Conduct.
required: true
- type: checkboxes
id: contributor-guidelines
attributes:
label: Contribution Guidelines
description: By submitting this issue, you agree to follow our [Contribution Guidelines.](https://insightsengineering.github.io/teal.widgets/CONTRIBUTING.html)
description: By submitting this issue, you agree to follow our [Contribution Guidelines.](https://insightsengineering.github.io/teal.widgets/latest-tag/CONTRIBUTING.html)
options:
- label: I agree to follow this project's Contribution Guidelines.
required: true
Expand Down
9 changes: 6 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Package: teal.widgets
Title: Shiny Widgets for `teal` Applications
Title: Shiny Widgets for 'teal' Applications
Version: 0.4.0.9008
Date: 2023-09-12
Authors@R: c(
Expand All @@ -12,8 +12,11 @@ Authors@R: c(
person("Junlue", "Zhao", role = "aut"),
person("F. Hoffmann-La Roche AG", role = c("cph", "fnd"))
)
Description: Collection of shiny widgets to support teal applications.
License: Apache License 2.0 | file LICENSE
Description: Collection of 'shiny' widgets to support 'teal' applications.
License: Apache License 2.0
URL: https://insightsengineering.github.io/teal.widgets/,
https://github.com/insightsengineering/teal.widgets
BugReports: https://github.com/insightsengineering/teal.widgets/issues
Depends:
R (>= 3.6)
Imports:
Expand Down
31 changes: 25 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# teal.widgets

<!-- start badges -->
[![CRAN Version](https://www.r-pkg.org/badges/version/teal.widgets?color=green)](https://cran.r-project.org/package=teal.widgets)
[![Total Downloads](http://cranlogs.r-pkg.org/badges/grand-total/teal.widgets?color=green)](https://cran.r-project.org/package=teal.widgets)
[![Last Month Downloads](http://cranlogs.r-pkg.org/badges/last-month/teal.widgets?color=green)](https://cran.r-project.org/package=teal.widgets)
[![Last Week Downloads](http://cranlogs.r-pkg.org/badges/last-week/teal.widgets?color=green)](https://cran.r-project.org/package=teal.widgets)

[![Check 🛠](https://github.com/insightsengineering/teal.widgets/actions/workflows/check.yaml/badge.svg)](https://insightsengineering.github.io/teal.widgets/main/unit-test-report/)
[![Docs 📚](https://github.com/insightsengineering/teal.widgets/actions/workflows/docs.yaml/badge.svg)](https://insightsengineering.github.io/teal.widgets/)
[![Code Coverage 📔](https://raw.githubusercontent.com/insightsengineering/teal.widgets/_xml_coverage_reports/data/main/badge.svg)](https://insightsengineering.github.io/teal.widgets/main/coverage-report/)
Expand All @@ -19,7 +24,7 @@
[![Open Issues](https://img.shields.io/github/issues-raw/insightsengineering/teal.widgets?color=red\&label=open%20issues)](https://github.com/insightsengineering/teal.widgets/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
<!-- end badges -->

This package provides various 'widgets' for `teal` applications. Examples include:
This package provides various widgets for `teal` applications. Examples include:

- `standard_layout` for a standard UI layout with output on the right and an encoding panel on the left
- `plot_with_settings` for a standard plot output UI with resizing and downloading options
Expand All @@ -29,17 +34,31 @@ This package provides various 'widgets' for `teal` applications. Examples includ

## Installation

From July 2023 `insightsengineering` packages are available on [r-universe](https://r-universe.dev/).

```r
# stable versions
install.packages('teal.widgets', repos = c('https://insightsengineering.r-universe.dev', 'https://cloud.r-project.org'))
install.packages('teal.widgets', repos = c('https://insightsengineering.r-universe.dev', getOption('repos')))

# install.packages("pak")
pak::pak("insightsengineering/teal.widgets@*release")
```

Alternatively, you might want to use the development version available on [r-universe](https://r-universe.dev/).

```r
# beta versions
install.packages('teal.widgets', repos = c('https://pharmaverse.r-universe.dev', 'https://cloud.r-project.org'))
install.packages('teal.widgets', repos = c('https://pharmaverse.r-universe.dev', getOption('repos')))

# install.packages("pak")
pak::pak("insightsengineering/teal.widgets")
```

See package vignettes `browseVignettes(package = "teal.widgets")` for usage of this package.
## Usage

To understand how to use this package, please refer to the [package website](https://insightsengineering.github.io/teal.widgets/), which provides multiple examples of code usage.

## Getting help

If you encounter a bug or you have a feature request - please file an issue. For questions, discussions and staying up to date, please use the "teal" channel in the [`pharmaverse` slack workspace](https://pharmaverse.slack.com).

## Stargazers and Forkers

Expand Down
9 changes: 9 additions & 0 deletions man/teal.widgets-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion vignettes/custom-basic-table-arguments.Rmd
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Custom basic_table arguments module"
author: "Maciej Nasiński"
date: "2021-12-01"
output: rmarkdown::html_vignette
runtime: shiny
vignette: >
Expand Down
1 change: 0 additions & 1 deletion vignettes/custom-ggplot2-arguments.Rmd
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Custom `ggplot2` arguments module"
author: "Maciej Nasiński"
date: "2021-12-01"
output: rmarkdown::html_vignette
runtime: shiny
vignette: >
Expand Down

0 comments on commit 3428dde

Please sign in to comment.