From c60e0ec7ac2d2b9c57448f487d19a6f164cc0463 Mon Sep 17 00:00:00 2001 From: m7pr Date: Tue, 12 Sep 2023 15:47:07 +0200 Subject: [PATCH 1/4] readme updates --- .Rbuildignore | 1 + .github/CONTRIBUTING.md | 6 ++--- .github/ISSUE_TEMPLATE/bug.yml | 4 +-- .github/ISSUE_TEMPLATE/feature.yml | 4 +-- .github/ISSUE_TEMPLATE/question.yml | 4 +-- DESCRIPTION | 9 ++++--- README.md | 29 ++++++++++++++++++---- vignettes/custom-basic-table-arguments.Rmd | 1 - vignettes/custom-ggplot2-arguments.Rmd | 1 - 9 files changed, 40 insertions(+), 19 deletions(-) diff --git a/.Rbuildignore b/.Rbuildignore index 8bd3c7cf..db2a0684 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,3 +1,4 @@ +LICENSE ^renv$ ^renv\.lock$ CODE_OF_CONDUCT.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 59ff26c9..bdc80667 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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. -[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 diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 826bdcfe..13be8a42 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -33,7 +33,7 @@ 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 @@ -41,7 +41,7 @@ body: 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 diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index 117f1b08..17aa27fe 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -13,7 +13,7 @@ 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 @@ -21,7 +21,7 @@ body: 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 diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index e78c853c..9f86a02a 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -13,7 +13,7 @@ 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 @@ -21,7 +21,7 @@ body: 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 diff --git a/DESCRIPTION b/DESCRIPTION index ca96bda5..6497c0d6 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -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( @@ -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: diff --git a/README.md b/README.md index aab612e7..8b168e91 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # teal.widgets +[![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/) @@ -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 diff --git a/vignettes/custom-basic-table-arguments.Rmd b/vignettes/custom-basic-table-arguments.Rmd index 8fbdac45..b135185a 100644 --- a/vignettes/custom-basic-table-arguments.Rmd +++ b/vignettes/custom-basic-table-arguments.Rmd @@ -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: > diff --git a/vignettes/custom-ggplot2-arguments.Rmd b/vignettes/custom-ggplot2-arguments.Rmd index cf59dece..777dedd9 100644 --- a/vignettes/custom-ggplot2-arguments.Rmd +++ b/vignettes/custom-ggplot2-arguments.Rmd @@ -1,7 +1,6 @@ --- title: "Custom `ggplot2` arguments module" author: "Maciej Nasiński" -date: "2021-12-01" output: rmarkdown::html_vignette runtime: shiny vignette: > From 4e0360459938a8764bee9f5e96c6520fbffe0c88 Mon Sep 17 00:00:00 2001 From: "27856297+dependabot-preview[bot]@users.noreply.github.com" <27856297+dependabot-preview[bot]@users.noreply.github.com> Date: Tue, 12 Sep 2023 13:51:02 +0000 Subject: [PATCH 2/4] [skip actions] Roxygen Man Pages Auto Update --- man/teal.widgets-package.Rd | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/man/teal.widgets-package.Rd b/man/teal.widgets-package.Rd index 7fe81805..4ee3ffb2 100644 --- a/man/teal.widgets-package.Rd +++ b/man/teal.widgets-package.Rd @@ -9,6 +9,15 @@ The \code{teal.widgets} package contains functionalities that can be used for \code{teal} module development. The package is dedicated to allow developers to extend module functionality by additional inputs and output controls. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://insightsengineering.github.io/teal.widgets/} + \item \url{https://github.com/insightsengineering/teal.widgets} + \item Report bugs at \url{https://github.com/insightsengineering/teal.widgets/issues} +} + } \author{ \strong{Maintainer}: Dawid Kaledkowski \email{dawid.kaledkowski@roche.com} From 1fb82defd174da7887df29359b7a37f1d39345a8 Mon Sep 17 00:00:00 2001 From: m7pr Date: Wed, 13 Sep 2023 10:46:53 +0200 Subject: [PATCH 3/4] remove quotes from widgets --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8b168e91..b3fd1538 100644 --- a/README.md +++ b/README.md @@ -24,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) -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 From c6462eefd2e86a73c3d2f9b0e035ce5110ef3a72 Mon Sep 17 00:00:00 2001 From: m7pr Date: Wed, 27 Sep 2023 13:15:28 +0200 Subject: [PATCH 4/4] fix Description Title and Description for CRAN release --- DESCRIPTION | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 6497c0d6..1a96b257 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -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( @@ -12,7 +12,8 @@ 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. +Description: Collection of 'shiny' widgets to support 'teal' applications. Enables the + manipulation of application layout and plot or table settings. License: Apache License 2.0 URL: https://insightsengineering.github.io/teal.widgets/, https://github.com/insightsengineering/teal.widgets