198 Include user's card labels when generating the report #241

kartikeyakirar · 2023-10-04T13:44:50Z

this PR fixes #240

this is follow-up after insightsengineering/teal.reporter#219

…ontent

…ineering/teal.goshawk into 198_card_labels@main

kartikeyakirar · 2023-10-06T08:07:59Z

CMD checks are failing because of mcr package is archived from CRAN

m7pr · 2023-10-06T13:40:07Z

@kartikeyakirar please take out card_template and move it to teal.reporter.
insightsengineering/teal.modules.general#584 (comment)

m7pr · 2023-10-06T13:40:22Z

@kartikeyakirar please take out card_template and move it to teal.reporter.
insightsengineering/teal.modules.general#584 (comment)

kartikeyakirar · 2023-10-11T12:34:48Z

please take out card_template and move it to teal.reporter.

Within this package, there is an additional common section that can be utilized in templates. Consequently, I am maintaining "card_template" as a wrapper for "teal.reporter::card_template."

m7pr

please append teal:: before report_card_template so it's easier for debugging in the future

R/tm_g_gh_boxplot.R

m7pr · 2023-10-12T10:08:10Z

R/utils.R

+#' @return (`TealReportCard`) populated with a title, description, and filter state
+#'
+#' @keywords internal
+report_card_template <- function(title,


@kartikeyakirar this is not a good idea to have the same name of the function in 2 packages. Please rename to report_card_template_goshawk

kartikeyakirar · 2023-10-12T10:11:48Z

@m7pr there is no namesapce call because its internal function I have defined report_card_template here in the utils, and it makes use of teal::report_card_template. https://github.com/insightsengineering/teal.goshawk/blob/198_card_labels%40main/R/utils.R#L35-L79

m7pr · 2023-10-12T10:14:38Z

CMD checks are failing because of mcr package is archived from CRAN
Is back on CRAN

Merge branch '198_card_labels@main' of https://github.com/insightsengineering/teal.goshawk into 198_card_labels@main # Conflicts: # R/utils.R

github-actions · 2023-10-12T10:29:36Z

Code Coverage Summary

Filename                                 Stmts    Miss  Cover    Missing
-------------------------------------  -------  ------  -------  ---------
R/tm_g_gh_boxplot.R                        353     353  0.00%    216-636
R/tm_g_gh_correlationplot.R                556     556  0.00%    282-944
R/tm_g_gh_density_distribution_plot.R      277     277  0.00%    161-487
R/tm_g_gh_lineplot.R                       563     563  0.00%    184-841
R/tm_g_gh_scatterplot.R                    239     239  0.00%    167-457
R/tm_g_gh_spaghettiplot.R                  291     291  0.00%    230-587
R/toggleable_slider.R                      154     154  0.00%    82-253
R/utils-arbitrary_lines.r                  121     121  0.00%    19-172
R/utils-data_constraints.r                 186     186  0.00%    2-255
R/utils-keep_range_slider_updated.r         23      23  0.00%    8-38
R/utils-maptrt.r                             9       9  0.00%    25-37
R/utils-templ_ui.r                          48      48  0.00%    2-73
R/utils.R                                   39      39  0.00%    12-83
R/zzz.R                                      1       1  0.00%    2
TOTAL                                     2860    2860  0.00%

Diff against main

Filename                                 Stmts    Miss  Cover
-------------------------------------  -------  ------  --------
R/tm_g_gh_boxplot.R                         +4      +4  +100.00%
R/tm_g_gh_correlationplot.R                 +4      +4  +100.00%
R/tm_g_gh_density_distribution_plot.R       +3      +3  +100.00%
R/tm_g_gh_lineplot.R                        +4      +4  +100.00%
R/tm_g_gh_scatterplot.R                     +4      +4  +100.00%
R/tm_g_gh_spaghettiplot.R                   +3      +3  +100.00%
R/utils.R                                  +22     +22  +100.00%
TOTAL                                      +44     +44  +100.00%

Results for commit: b10f687

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

m7pr · 2023-10-12T13:10:52Z

#241 (comment)

R/utils.R

m7pr · 2023-10-13T09:30:39Z

Hey @kartikeyakirar looks like this staged deps cyclic error does not appear on this PR anymore. You are good to merge.
Just add .lintr indentaion = NULL so that lintr tests are fixed

#933) this PR is extension to insightsengineering/teal.reporter#198 Here I have added card_template() function that generates a report card with a title, an optional description, and the option to append the filter state list. and is been used in insightsengineering/teal.modules.general#584 insightsengineering/teal.modules.clinical#835 insightsengineering/teal.modules.hermes#336 insightsengineering/teal.osprey#229 insightsengineering/teal.goshawk#241 ref issues and discussion: insightsengineering/teal.reporter#226 --------- Signed-off-by: kartikeya kirar <[email protected]> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Marcin <[email protected]> Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>

kartikeyakirar added 2 commits October 4, 2023 19:13

add card_template function and allow to pass label to reporter card c…

fd9baaa

…ontent

Merge fd9baaa into 6fb64c3

e5e941b

kartikeyakirar marked this pull request as draft October 4, 2023 13:45

[skip actions] Restyle files

aae8874

kartikeyakirar mentioned this pull request Oct 4, 2023

198 Include user's card labels when generating the report insightsengineering/teal.modules.clinical#835

Merged

kartikeyakirar added 4 commits October 6, 2023 02:23

adding option selection section in card_template.

b71ed51

Merge branch '198_card_labels@main' of https://github.com/insightseng…

402ffc8

…ineering/teal.goshawk into 198_card_labels@main

fixing indentation.

1a26427

Merge 1a26427 into 6fb64c3

7301664

kartikeyakirar marked this pull request as ready for review October 5, 2023 21:03

github-actions bot and others added 2 commits October 5, 2023 21:05

[skip actions] Restyle files

9e19c70

'Empty-Commit'

e079528

kartikeyakirar self-assigned this Oct 6, 2023

kartikeyakirar added the core label Oct 6, 2023

kartikeyakirar removed their assignment Oct 6, 2023

m7pr self-requested a review October 6, 2023 13:37

m7pr mentioned this pull request Oct 6, 2023

198 Include user's card labels when generating the report insightsengineering/teal.modules.general#584

Merged

wrapper function for teal.reporter card_template

2118b41

kartikeyakirar and others added 3 commits October 12, 2023 15:24

renaming to report_card_template

2a4c5a7

Merge 2a4c5a7 into 6fb64c3

5dc9092

[skip actions] Restyle files

fe35a27

m7pr requested changes Oct 12, 2023

View reviewed changes

R/tm_g_gh_boxplot.R Outdated Show resolved Hide resolved

m7pr requested changes Oct 12, 2023

View reviewed changes

renaming to report_card_template_goshawk

e7f44be

kartikeyakirar and others added 2 commits October 12, 2023 15:50

empty commit

5d51479

Merge branch '198_card_labels@main' of https://github.com/insightsengineering/teal.goshawk into 198_card_labels@main # Conflicts: # R/utils.R

[skip actions] Roxygen Man Pages Auto Update

4077203

kartikeyakirar and others added 3 commits October 12, 2023 16:00

'Empty-Commit'

d5fc23b

replacing Rd file

90fa05d

[skip actions] Roxygen Man Pages Auto Update

e8ad09a

m7pr approved these changes Oct 12, 2023

View reviewed changes

m7pr self-requested a review October 12, 2023 13:14

m7pr requested changes Oct 12, 2023

View reviewed changes

R/utils.R Outdated Show resolved Hide resolved

kartikeyakirar and others added 2 commits October 12, 2023 19:10

Adding description and changing case.

1daee0c

[skip actions] Roxygen Man Pages Auto Update

5481ed8

m7pr approved these changes Oct 12, 2023

View reviewed changes

kartikeyakirar mentioned this pull request Oct 12, 2023

198 extension to Include user's card labels when generating the report insightsengineering/teal#933

Merged

kartikeyakirar and others added 4 commits October 12, 2023 23:05

'Empty-Commit'

11108d4

updating rd

28a101a

[skip actions] Roxygen Man Pages Auto Update

aecdef4

'Empty-Commit'

97042ba

fixing linter issue.

b10f687

kartikeyakirar enabled auto-merge (squash) October 13, 2023 09:49

kartikeyakirar merged commit 81ae566 into main Oct 13, 2023
22 checks passed

kartikeyakirar deleted the 198_card_labels@main branch October 13, 2023 09:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

198 Include user's card labels when generating the report #241

198 Include user's card labels when generating the report #241

kartikeyakirar commented Oct 4, 2023

kartikeyakirar commented Oct 6, 2023

m7pr commented Oct 6, 2023

m7pr commented Oct 6, 2023

kartikeyakirar commented Oct 11, 2023

m7pr left a comment

m7pr Oct 12, 2023

kartikeyakirar commented Oct 12, 2023

m7pr commented Oct 12, 2023

github-actions bot commented Oct 12, 2023 •

edited

Loading

m7pr commented Oct 12, 2023

m7pr commented Oct 13, 2023

198 Include user's card labels when generating the report #241

198 Include user's card labels when generating the report #241

Conversation

kartikeyakirar commented Oct 4, 2023

kartikeyakirar commented Oct 6, 2023

m7pr commented Oct 6, 2023

m7pr commented Oct 6, 2023

kartikeyakirar commented Oct 11, 2023

m7pr left a comment

Choose a reason for hiding this comment

m7pr Oct 12, 2023

Choose a reason for hiding this comment

kartikeyakirar commented Oct 12, 2023

m7pr commented Oct 12, 2023

github-actions bot commented Oct 12, 2023 • edited Loading

Code Coverage Summary

Diff against main

m7pr commented Oct 12, 2023

m7pr commented Oct 13, 2023

github-actions bot commented Oct 12, 2023 •

edited

Loading