Expanded the loading data vignette #780
Merged
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
jnolis
commented
Feb 10, 2022
R/utils-data.R
Outdated
| #' the dataloader. `.getbatch` must work for batches of size larger or equal to 1. | ||
| #' | ||
| #' the dataloader. `.getbatch` must work for batches of size larger or equal to 1. For more | ||
| #' on this see the the vignette on data loading. |
There was a problem hiding this comment.
This ideally would have a link to the vignette
|
Also if this is helpful I bet I could do it for other pages too! |
dfalbel
approved these changes
Feb 10, 2022
R/utils-data.R
Outdated
| #' the dataloader. `.getbatch` must work for batches of size larger or equal to 1. | ||
| #' | ||
| #' the dataloader. `.getbatch` must work for batches of size larger or equal to 1. For more | ||
| #' on this see the the vignette on data loading. |
There was a problem hiding this comment.
This will make at least the pkgdown website to create a link:
Suggested change
| #' on this see the the vignette on data loading. | |
| #' on this see the the `vignette("loading-data")`. |
Up to you if you prefer adding this or not. I think most users will read it in the Rd format.
Let me know what you prefer and I'll merge this PR.
Yeah! Please do, that's super helpful! |
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.
I expanded the load data vignette to give more of a gentle introduction for new users. I also added a part at the end about optimizing data loads that mentions getbatch and avoiding datasets entirely.
I also added a sentence or two to the
datasetdocs, although I wasn't sure how to have a hyperlink to the vignette (I'm not an R package expert)