Closes #96 general issue increase test coverage for dataset_vignette.R #120
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…-dataset_vignetter
|
bms63
reviewed
Oct 12, 2022
| test_that("dataset_vignette Test 1: a 'knitr_kable' object is output when run outside pkgdown", { | ||
| # dataset_vignette | ||
| ## Test 1: A 'knitr_kable' object is output when run outside pkgdown ---- | ||
| test_that("Test 1: A 'knitr_kable' object is output when run outside pkgdown", { |
There was a problem hiding this comment.
Suggested change
| test_that("Test 1: A 'knitr_kable' object is output when run outside pkgdown", { | |
| test_that("dataset_vignette Test 1: A 'knitr_kable' object is output when run outside pkgdown", { |
We actually want it the other way. :) https://pharmaverse.github.io/admiraldev/devel/articles/unit_test_guidance.html#set-up-the-test-script
There was a problem hiding this comment.
@zdz2101 , you can easily achieve the correct formatting by calling the "format test_that test file" addin (see https://pharmaverse.github.io/admiraldev/devel/articles/unit_test_guidance.html#addin-admiraldevformat_test_that_file).
bms63
reviewed
Oct 12, 2022
| @@ -1,23 +1,34 @@ | |||
| library(admiral.test) | |||
There was a problem hiding this comment.
Can you remove this from the script
bms63
reviewed
Oct 12, 2022
| ## Test 2: a 'datatables' object is output when run inside pkgdown ---- | ||
| test_that("dataset_vignette Test 2: a 'datatables' object is output when run inside pkgdown", { | ||
| ## Test 2: A 'datatables' object is output when run inside pkgdown ---- | ||
| test_that("Test 2: A 'datatables' object is output when run inside pkgdown", { | ||
| Sys.setenv(IN_PKGDOWN = "true") | ||
| on.exit(Sys.setenv(IN_PKGDOWN = "")) | ||
| expect_s3_class(dataset_vignette(head(admiral_dm)), "datatables") |
There was a problem hiding this comment.
Can you also update the calls like this for test data? Or just make some simple dummy data and remove the dependency all together.
Suggested change
| expect_s3_class(dataset_vignette(head(admiral_dm)), "datatables") | |
| expect_s3_class(dataset_vignette(head(admiral.test::admiral_dm)), "datatables") |
|
Thanks so much for doing your first PR. Day 2!! :) |
|
Great to see your first PR @zdz2101! Sorry to be uber-nitpicky but in the future please use |
…r error when calling column not in dataset.
…-dataset_vignetter
bms63
reviewed
Oct 13, 2022
Comment on lines
37
to
38
| ## Test 3: An error is output when calling variable not in dataset ---- | ||
| test_that("dataset_vignette Test 3: An error is output when calling variable not in dataset", { |
There was a problem hiding this comment.
Suggested change
| ## Test 3: An error is output when calling variable not in dataset ---- | |
| test_that("dataset_vignette Test 3: An error is output when calling variable not in dataset", { | |
| ## Test 3: An error is outputted when calling variable not in dataset ---- | |
| test_that("dataset_vignette Test 3: An error is outputted when calling variable not in dataset", { |
bms63
reviewed
Oct 13, 2022
Comment on lines
19
to
20
| ## Test 2: A 'datatables' object is output when run inside pkgdown ---- | ||
| test_that("dataset_vignette Test 2: A 'datatables' object is output when run inside pkgdown", { |
There was a problem hiding this comment.
Suggested change
| ## Test 2: A 'datatables' object is output when run inside pkgdown ---- | |
| test_that("dataset_vignette Test 2: A 'datatables' object is output when run inside pkgdown", { | |
| ## Test 2: A 'datatables' object is outputted when run inside pkgdown ---- | |
| test_that("dataset_vignette Test 2: A 'datatables' object is outputted when run inside pkgdown", { |
bms63
reviewed
Oct 13, 2022
Comment on lines
2
to
3
| ## Test 1: A 'knitr_kable' object is output when run outside pkgdown ---- | ||
| test_that("dataset_vignette Test 1: A 'knitr_kable' object is output when run outside pkgdown", { |
There was a problem hiding this comment.
Suggested change
| ## Test 1: A 'knitr_kable' object is output when run outside pkgdown ---- | |
| test_that("dataset_vignette Test 1: A 'knitr_kable' object is output when run outside pkgdown", { | |
| ## Test 1: A 'knitr_kable' object is outputted when run outside pkgdown ---- | |
| test_that("dataset_vignette Test 1: A 'knitr_kable' object is outputted when run outside pkgdown", { |
bms63
approved these changes
Oct 13, 2022
|
Also best practice is to put the issue #96 in the commit message |
bms63
deleted the
96-general-issue-increase-test-coverage-for-dataset_vignetter
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral codebase remains robust and consistent.
Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the
develbranch until you have checked off each task.styler::style_file()to style R and Rmd filesdevtools::document()so all.Rdfiles in themanfolder and theNAMESPACEfile in the project root are updated appropriatelyNEWS.mdif the changes pertain to a user-facing function (i.e. it has an@exporttag) or documentation aimed at users (rather than developers)pkgdown::build_site()and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.lintr::lint_package()R CMD checklocally and address all errors and warnings -devtools::check()