Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update install guide; add getting help; pkg name lowercase #890

Merged
merged 11 commits into from
Aug 10, 2023

Conversation

pawelru
Copy link
Contributor

@pawelru pawelru commented Aug 4, 2023

  • update install guide - added back install from GH as this is still a standard way of installing non-CRAN packages. I added install via pak and not remotes because this is also standard for pkgs from tidyverse or r-lib.
  • change urls to teal gallery and tlg-catalog
  • added Getting Help section with reference to slack channel
  • replace browseVignettes(package = "teal") with url as I believe that most of users will read README from within pkgdown webpage.
  • replace "Teal" with "teal" to keep consistent package name
  • UPDATE: added "Usage section" with gif recording and move all "Please refer to ... for more" under that section

Please add your feedback. I would like to treat this PR as a reference to the issue for other package updates.

@pawelru pawelru requested a review from a team August 4, 2023 10:39
@pawelru pawelru added the core label Aug 4, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Aug 4, 2023

Unit Tests Summary

    1 files    16 suites   16s ⏱️
171 tests 171 ✔️ 0 💤 0
341 runs  341 ✔️ 0 💤 0

Results for commit 1b053d9.

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Contributor

github-actions bot commented Aug 4, 2023

badge

Code Coverage Summary

Filename                         Stmts    Miss  Cover    Missing
-----------------------------  -------  ------  -------  ----------------------------------------------------------------------------------
R/dummy_functions.R                 88      63  28.41%   9-76, 101-104, 107-111
R/get_rcode_utils.R                 46       1  97.83%   49
R/include_css_js.R                  24       0  100.00%
R/init.R                            77      28  63.64%   171-178, 183-204, 216-218
R/module_filter_manager.R          107      29  72.90%   62-70, 79-84, 227, 232-245
R/module_nested_tabs.R             170      16  90.59%   72, 119, 123-124, 138-145, 163, 216, 238, 271
R/module_snapshot_manager.R        148     105  29.05%   71-82, 109-118, 122-134, 136-143, 149-164, 177-200, 203-214, 217-223, 237, 258-281
R/module_tabs_with_filters.R        67       1  98.51%   95
R/module_teal_with_splash.R         33       2  93.94%   65, 77
R/module_teal.R                    164      12  92.68%   68, 71, 158-159, 209-210, 230-233, 235, 239
R/modules_debugging.R               18      18  0.00%    25-44
R/modules.R                        118      17  85.59%   206-211, 330-373
R/reporter_previewer_module.R       16       2  87.50%   23, 27
R/show_rcode_modal.R                20      20  0.00%    16-37
R/tdata.R                           41       2  95.12%   146, 172
R/teal_reporter.R                   60       5  91.67%   65, 116-117, 120, 137
R/teal_slices.R                     45       0  100.00%
R/utils.R                           21       0  100.00%
R/validate_inputs.R                 32       0  100.00%
R/validations.R                     60      37  38.33%   111-373
R/zzz.R                             11       7  36.36%   3-14
TOTAL                             1366     365  73.28%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: 706f6b0

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Co-authored-by: Aleksander Chlebowski <[email protected]>
Signed-off-by: Pawel Rucki <[email protected]>
README.md Outdated
@@ -1,4 +1,4 @@
# Teal: Interactive Exploratory Data Analysis with Shiny Web-Applications <a href='https://insightsengineering.github.io/teal/'><img src="man/figures/teal.png" align="right" height="139" style="max-width: 100%;"/></a >
# teal: Interactive Exploratory Data Analysis with Shiny Web-Applications <a href='https://insightsengineering.github.io/teal/'><img src="man/figures/teal.png" align="right" height="139" style="max-width: 100%;"/></a >
Copy link
Contributor

@gogonzo gogonzo Aug 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about removing image and keeping duck as icon :D
BTW. thin about that mojo accepts emoji as file extension. I wonder if our files could be similar hehe

Suggested change
# teal: Interactive Exploratory Data Analysis with Shiny Web-Applications <a href='https://insightsengineering.github.io/teal/'><img src="man/figures/teal.png" align="right" height="139" style="max-width: 100%;"/></a >
# teal 🦆: Interactive Exploratory Data Analysis with Shiny Web-Applications

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am good with emoji icon but would like to keep the hexagon badge also

README.md Outdated Show resolved Hide resolved
Co-authored-by: kartikeya kirar <[email protected]>
Signed-off-by: Pawel Rucki <[email protected]>
@pawelru
Copy link
Contributor Author

pawelru commented Aug 8, 2023

UPDATE: Added Usage section with gif recording

Copy link
Contributor

@kartikeyakirar kartikeyakirar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Copy link
Contributor

@averissimo averissimo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :+1

@pawelru pawelru merged commit 39a98f4 into main Aug 10, 2023
22 checks passed
@pawelru pawelru deleted the readme_updates branch August 10, 2023 08:08
@pawelru pawelru mentioned this pull request Aug 10, 2023
@pawelru
Copy link
Contributor Author

pawelru commented Aug 10, 2023

I made a mistake in this PR. Please have a look also at the follow-up PR here: #894

pawelru added a commit that referenced this pull request Aug 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants