Update article links in README, intro vignette #124
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
amanda-hi
reviewed
May 15, 2024
README.Rmd
Outdated
| @@ -194,7 +194,7 @@ to users to run canned examples (or analyses). They can be accessed once | |||
| + [dplyr](https://dplyr.tidyverse.org) and [tidyr](https://tidyr.tidyverse.org) verb | |||
| S3 methods for the `soma_adat` class. | |||
| + `?rownames` helpers that do not break `soma_adat` attributes. | |||
| + please see vignette `vignette("tips-loading-and-wrangling", package = "SomaDataIO")` | |||
| + please see vignette [Loading and Wrangling 'SomaScan'](https://somalogic.github.io/SomaDataIO/articles/tips-loading-and-wrangling.html) | |||
There was a problem hiding this comment.
I think, for the sake of clarity, we might want to refer to these as "articles" and "workflows" (when appropriate) to reduce confusion for the reader, since that is how they're listed on the pkgdown site. The only true vignette in the package is the SomaDataIO.Rmd file. So this could be modified to say "please see the article [Loading and Wrangling 'SomaScan...."
amanda-hi
reviewed
May 15, 2024
README.Rmd
Outdated
| @@ -217,7 +217,7 @@ is.soma_adat(my_adat) | |||
| my_adat | |||
| ``` | |||
|
|
|||
| Please see vignette `vignette("tips-loading-and-wrangling", package = "SomaDataIO")` | |||
| Please see the vignette [Loading and Wrangling SomaScan](https://somalogic.github.io/SomaDataIO/articles/tips-loading-and-wrangling.html) | |||
There was a problem hiding this comment.
Same as above, update to use "article" instead of vignette
amanda-hi
reviewed
May 15, 2024
vignettes/SomaDataIO.Rmd
Outdated
|
|
||
| Note that, in an effort to reduce dependencies, these articles are only |
There was a problem hiding this comment.
You refer to them as an "article" here, that's also why I think it would be better to use "article" in the bullet points above
- updated links to articles in README and introduction vignette to URLs to pkgdown website rather than `vignette()` code references - added clarification to above documents that articles are available on website only rather than traditional vignettes included with package in effort to reduce package size and dependencies - closes SomaLogic#123
scheidec
force-pushed
the
fix-article-links
branch
from
5d8ee9b to
fafafd4
Compare
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.
vignette()code referencesFixes #123