Merge branch 'main' into 185_fixing_formating@main

insightsengineering · Sep 14, 2023 · 7a8ccd5 · 7a8ccd5
2 parents b3aab20 + 89546d6
commit 7a8ccd5
Show file tree

Hide file tree

Showing 11 changed files with 71 additions and 30 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -1,3 +1,5 @@
+^assets$
+^venv$
 LICENSE
 dev/internal_examples.R
 ^.*\.Rproj$

diff --git 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.
 
 <!-- urls -->
-[docs]: https://insightsengineering.github.io/teal.reporter/index.html
-[articles]: https://insightsengineering.github.io/teal.reporter/main/articles/index.html
-[license]: https://insightsengineering.github.io/teal.reporter/main/LICENSE-text.html
+[docs]: https://insightsengineering.github.io/teal.reporter/latest-tag/index.html
+[articles]: https://insightsengineering.github.io/teal.reporter/latest-tag/articles/index.html
+[license]: https://insightsengineering.github.io/teal.reporter/latest-tag//LICENSE-text.html
 [insights]: https://github.com/insightsengineering/teal.reporter/pulse
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -21,35 +21,45 @@ body:
     id: session-info
     attributes:
       label: sessionInfo()
-      description: Please copy and paste your output from `sessionInfo()`. This will be automatically formatted into code, so no need for backticks.
+      description: |
+          Please copy and paste your output from `sessionInfo()`. This will be
+          automatically formatted into code, so no need for backticks.
       render: R
   - type: textarea
     id: logs
     attributes:
       label: Relevant log output
-      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      description: |
+          Please copy and paste any relevant log output. This will be
+          automatically formatted into code, so no need for backticks.
       render: R
   - type: checkboxes
     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.reporter/CODE_OF_CONDUCT.html)
+      description: |
+          By submitting this issue, you agree to follow our
+          [Code of Conduct.](https://insightsengineering.github.io/teal.reporter/latest-tag/CODE_OF_CONDUCT.html) # nolint
       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.reporter/CONTRIBUTING.html)
+      description: |
+          By submitting this issue, you agree to follow our
+          [Contribution Guidelines.](https://insightsengineering.github.io/teal.reporter/latest-tag/CONTRIBUTING.html) # nolint
       options:
         - label: I agree to follow this project's Contribution Guidelines.
           required: true
   - type: checkboxes
     id: security-policy
     attributes:
       label: Security Policy
-      description: By submitting this issue, you agree to follow our [Security Policy.](https://github.com/insightsengineering/teal.reporter/security/policy)
+      description: |
+          By submitting this issue, you agree to follow our
+          [Security Policy.](https://github.com/insightsengineering/teal.reporter/security/policy) # nolint
       options:
         - label: I agree to follow this project's Security Policy.
           required: true
diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml
@@ -13,23 +13,29 @@ 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.reporter/CODE_OF_CONDUCT.html)
+      description: |
+          By submitting this issue, you agree to follow our
+          [Code of Conduct.](https://insightsengineering.github.io/teal.reporter/latest-tag/CODE_OF_CONDUCT.html) # nolint
       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.reporter/CONTRIBUTING.html)
+      description: |
+          By submitting this issue, you agree to follow our
+          [Contribution Guidelines.](https://insightsengineering.github.io/teal.reporter/latest-tag/CONTRIBUTING.html) # nolint
       options:
         - label: I agree to follow this project's Contribution Guidelines.
           required: true
   - type: checkboxes
     id: security-policy
     attributes:
       label: Security Policy
-      description: By submitting this issue, you agree to follow our [Security Policy.](https://github.com/insightsengineering/teal.reporter/security/policy)
+      description: |
+          By submitting this issue, you agree to follow our
+          [Security Policy.](https://github.com/insightsengineering/teal.reporter/security/policy) # nolint
       options:
         - label: I agree to follow this project's Security Policy.
           required: true
diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml
@@ -13,23 +13,29 @@ 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.reporter/CODE_OF_CONDUCT.html)
+      description: |
+          By submitting this issue, you agree to follow our
+          [Code of Conduct.](https://insightsengineering.github.io/teal.reporter/latest-tag/CODE_OF_CONDUCT.html) # nolint
       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.reporter/CONTRIBUTING.html)
+      description: |
+          By submitting this issue, you agree to follow our
+          [Contribution Guidelines.](https://insightsengineering.github.io/teal.reporter/latest-tag/CONTRIBUTING.html) # nolint
       options:
         - label: I agree to follow this project's Contribution Guidelines.
           required: true
   - type: checkboxes
     id: security-policy
     attributes:
       label: Security Policy
-      description: By submitting this issue, you agree to follow our [Security Policy.](https://github.com/insightsengineering/teal.reporter/security/policy)
+      description: |
+          By submitting this issue, you agree to follow our
+          [Security Policy.](https://github.com/insightsengineering/teal.reporter/security/policy) # nolint
       options:
         - label: I agree to follow this project's Security Policy.
           required: true
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: teal.reporter
 Title: Reporting Tools for 'shiny' Modules
-Version: 0.2.1.9000
-Date: 2023-09-11
+Version: 0.2.1.9002
+Date: 2023-09-13
 Authors@R: c(
     person("Dawid", "Kaledkowski", , "[email protected]", role = "cre"),
     person("Maciej", "Nasinski", role = "aut"),

diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,4 @@
-# teal.reporter 0.2.1.9000
+# teal.reporter 0.2.1.9002
 
 # teal.reporter 0.2.1
 

diff --git a/README.md b/README.md
@@ -1,8 +1,14 @@
 # teal.reporter
 
 <!-- start badges -->
+
+[![CRAN Version](https://www.r-pkg.org/badges/version/teal.reporter?color=green)](https://cran.r-project.org/package=teal.reporter)
+[![Total Downloads](http://cranlogs.r-pkg.org/badges/grand-total/teal.reporter?color=green)](https://cran.r-project.org/package=teal.reporter)
+[![Last Month Downloads](http://cranlogs.r-pkg.org/badges/last-month/teal.reporter?color=green)](https://cran.r-project.org/package=teal.reporter)
+[![Last Week Downloads](http://cranlogs.r-pkg.org/badges/last-week/teal.reporter?color=green)](https://cran.r-project.org/package=teal.reporter)
+
 [![Check 🛠](https://github.com/insightsengineering/teal.reporter/actions/workflows/check.yaml/badge.svg)](https://insightsengineering.github.io/teal.reporter/main/unit-test-report/)
-[![Docs 📚](https://github.com/insightsengineering/teal.reporter/actions/workflows/docs.yaml/badge.svg)](https://insightsengineering.github.io/teal.reporter/)
+[![Docs 📚](https://github.com/insightsengineering/teal.reporter/actions/workflows/docs.yaml/badge.svg)](https://insightsengineering.github.io/teal.reporter/latest-tag/)
 [![Code Coverage 📔](https://raw.githubusercontent.com/insightsengineering/teal.reporter/_xml_coverage_reports/data/main/badge.svg)](https://insightsengineering.github.io/teal.reporter/main/coverage-report/)
 
 ![GitHub forks](https://img.shields.io/github/forks/insightsengineering/teal.reporter?style=social)
@@ -19,8 +25,7 @@
 [![Open Issues](https://img.shields.io/github/issues-raw/insightsengineering/teal.reporter?color=red\&label=open%20issues)](https://github.com/insightsengineering/teal.reporter/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
 <!-- end badges -->
 
-`teal.reporter` enables `shiny` and `teal` applications to include reporting functionality.
-The `shiny` app developer (or `teal` module developer) specifies the content of the report and the `teal.reporter` package handles everything else.
+`teal.reporter` empowers both `shiny` and `teal` applications to seamlessly integrate reporting functionality. Developers, whether working on a `shiny` app or a `teal` module, define the report's content, while `teal.reporter` takes care of the rest.
 
 This package provides:
 
@@ -30,17 +35,33 @@ This package provides:
 
 ## Installation
 
-From July 2023 `insightsengineering` packages are available on [r-universe](https://r-universe.dev/).
-
 ```r
 # stable versions
-install.packages('teal.reporter', repos = c('https://insightsengineering.r-universe.dev', 'https://cloud.r-project.org'))
+install.packages('teal.reporter')
+
+# install.packages("pak")
+pak::pak("insightsengineering/teal.reporter@*release")
+```
+
+Alternatively, you might want to use the development version available on [r-universe](https://r-universe.dev/).
 
+```r
 # beta versions
-install.packages('teal.reporter', repos = c('https://pharmaverse.r-universe.dev', 'https://cloud.r-project.org'))
+install.packages('teal.reporter', repos = c('https://pharmaverse.r-universe.dev', getOption('repos')))
+
+# install.packages("pak")
+pak::pak("insightsengineering/teal.reporter")
 ```
 
-See package vignettes `browseVignettes(package = "teal.reporter")` for usage of this package.
+## Usage
+
+To understand how to use this package, please refer to the [Getting Started](https://insightsengineering.github.io/teal.reporter/latest-tag/articles/teal-reporter.html) article, which provides multiple examples of code implementation.
+
+![Showcase](https://github.com/insightsengineering/teal.reporter/blob/main/assets/img/showcase.gif)
+
+## 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/assets/img/showcase.gif b/assets/img/showcase.gif
diff --git a/staged_dependencies.yaml b/staged_dependencies.yaml
@@ -21,9 +21,6 @@ downstream_repos:
   insightsengineering/teal.modules.hermes:
     repo: insightsengineering/teal.modules.hermes
     host: https://github.com
-  insightsengineering/teal.modules.helios:
-    repo: insightsengineering/teal.modules.helios
-    host: https://github.com
 upstream_repos:
   insightsengineering/rtables:
     repo: insightsengineering/rtables

diff --git a/vignettes/teal-reporter.Rmd b/vignettes/teal-reporter.Rmd
@@ -1,6 +1,5 @@
 ---
 title: "Getting Started with teal.reporter"
-date: "2022-06-08"
 output: rmarkdown::html_vignette
 vignette: >
   %\VignetteIndexEntry{Getting Started with teal.reporter}
@@ -44,7 +43,7 @@ If you want to let the users of your application preview a report and reorganize
 
 ### Integration with `teal`
 If you are interested in how `teal.reporter` fits into [`teal`](https://insightsengineering.github.io/teal/), look for
-[a vignette about it in `teal`](https://insightsengineering.github.io/teal/main/articles/adding-support-for-reporting.html).
+[a vignette about it in `teal`](https://insightsengineering.github.io/teal/latest-tag/articles/adding-support-for-reporting.html).
 
 ### More control
 If you would like more control over the layout of a simple reporting tool, we recommend reading through the documentation