readme updates #166
Merged
readme updates #166
Conversation
This file contains hidden or 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
Contributor
|
Code Coverage SummaryDiff against mainResults for commit: e97c0b7 Minimum allowed coverage is ♻️ This comment has been updated with latest results |
Contributor
Signed-off-by: Marcin <133694481+m7pr@users.noreply.github.com>
Contributor
|
Looks Good 👍 |
averissimo
requested changes
Sep 13, 2023
Contributor
There was a problem hiding this comment.
I can't comment on code as it wasn't changed, but on vignettes/teal-data.Rmd it is using the .../main/... on the {teal} URLs instead of the latest-tag
Do you mind if I commit to the branch?
diff --git a/vignettes/teal-data.Rmd b/vignettes/teal-data.Rmd
index 67cdb47..32429a7 100644
--- a/vignettes/teal-data.Rmd
+++ b/vignettes/teal-data.Rmd
@@ -43,9 +43,9 @@ my_general_data <- teal_data(
The `teal.data` package provides many features to help specify your data:
-- [Specifying `ADaM` data](https://insightsengineering.github.io/teal/main/articles/including-adam-data-in-teal.html)
-- [Specifying `MultiAssayExperiment` data](https://insightsengineering.github.io/teal/main/articles/including-mae-data-in-teal.html)
-- [Specifying general relational data](https://insightsengineering.github.io/teal/main/articles/including-general-data-in-teal.html)
+- [Specifying `ADaM` data](https://insightsengineering.github.io/teal/latest-tag/articles/including-adam-data-in-teal.html)
+- [Specifying `MultiAssayExperiment` data](https://insightsengineering.github.io/teal/latest-tag/articles/including-mae-data-in-teal.html)
+- [Specifying general relational data](https://insightsengineering.github.io/teal/latest-tag/articles/including-general-data-in-teal.html)
- [Specifying relationships between your datasets](join-keys.html)
- [Dynamically loading your data (`DDL`)](using-delayed-data-basic.html)
- [Pre-processing data](preprocessing-data.html)
Contributor
Author
|
Thanks for noticing! Fixed in here 07f4a36 |
donyunardi
requested changes
Sep 14, 2023
Contributor
donyunardi
left a comment
donyunardi
left a comment
There was a problem hiding this comment.
I ran the urlchecker::url_check() and got this message:
✖ Error: man/col_labels.Rd:8:7 Error: CRAN URL not in canonical form
\href{https://cran.r-project.org/web/packages/formatters/index.html}{formatters} package, to reduce the complexity of
✖ Error: man/col_relabel.Rd:8:7 Error: CRAN URL not in canonical form
\href{https://cran.r-project.org/web/packages/formatters/index.html}{formatters} package, to reduce the complexity of
Should we update the formatters URL in the roxygen note for these two functions to:
\href{https://cran.r-project.org/package=formatters}{formatters}
averissimo
approved these changes
Sep 14, 2023
Contributor
averissimo
left a comment
averissimo
left a comment
There was a problem hiding this comment.
LGTM after addressing @donyunardi's comment about urls
Contributor
Author
|
Thanks @donyunardi - really good finding! Thanks for double checking |
Contributor
Author
|
Feedback addresses, waiting for @donyunardi to re-review and accept! |
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.
Related to https://github.com/insightsengineering/coredev-tasks/issues/462