Skip to content

Commit

Permalink
Update article links in README, intro vignette
Browse files Browse the repository at this point in the history
- 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 dependencies
- closes #123
  • Loading branch information
scheidec committed May 15, 2024
1 parent bda55a1 commit 5d8ee9b
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 28 deletions.
17 changes: 10 additions & 7 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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)

* Exporting data (Output)
+ write out a `soma_adat` object as a `*.adat` text file.
Expand All @@ -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)
for more details and options.


Expand All @@ -233,7 +233,7 @@ S3 methods to the most popular
methods(class = "soma_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)
for more details about available `soma_adat` methods.


Expand All @@ -254,20 +254,23 @@ For further detail please see:

- Two-group comparison (e.g. differential expression) via *t*-test
+ see `stats::t.test()`
+ see vignette `vignette("stat-two-group-comparison", package = "SomaDataIO")`
+ see vignette: [Two-Group Comparison](https://somalogic.github.io/SomaDataIO/articles/stat-two-group-comparison.html)

- Multi-group comparison (e.g. differential expression) via ANOVA
+ see `stats::aov()`
+ see vignette `vignette("stat-three-group-analysis-anova", package = "SomaDataIO")`
+ see vignette: [ANOVA Three-Group Analysis](https://somalogic.github.io/SomaDataIO/articles/stat-three-group-analysis-anova.html)

- Binary classification
+ see `stats::glm()`
+ see vignette `vignette("stat-binary-classification", package = "SomaDataIO")`
+ see vignette: [Binary Classification](https://somalogic.github.io/SomaDataIO/articles/stat-binary-classification.html)

- Linear regression
+ see `stats::lm()`
+ see vignette `vignette("stat-linear-regression", package = "SomaDataIO")`
+ see vignette: [Linear Regression](https://somalogic.github.io/SomaDataIO/articles/stat-linear-regression.html)

Note that, in an effort to reduce dependencies, these articles are only
accessible via the `SomaDataIO` `pkgdown` website, and are not included with the
installed package.

---------------------

Expand Down
36 changes: 20 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,8 @@ to run canned examples (or analyses). They can be accessed once
[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)
- Exporting data (Output)
- write out a `soma_adat` object as a `*.adat` text file.

Expand Down Expand Up @@ -230,9 +230,9 @@ my_adat
#> ════════════════════════════════════════════════════════════════════════════════
```

Please see vignette
`vignette("tips-loading-and-wrangling", package = "SomaDataIO")` for
more details and options.
Please see the vignette [Loading and Wrangling
SomaScan](https://somalogic.github.io/SomaDataIO/articles/tips-loading-and-wrangling.html)
for more details and options.

## Wrangling

Expand All @@ -254,9 +254,9 @@ methods(class = "soma_adat")
#> see '?methods' for accessing help and source code
```

Please see vignette
`vignette("tips-loading-and-wrangling", package = "SomaDataIO")` for
more details about available `soma_adat` methods.
Please see the vignette [Loading and Wrangling
SomaScan](https://somalogic.github.io/SomaDataIO/articles/tips-loading-and-wrangling.html)
for more details about available `soma_adat` methods.

## ADAT structure

Expand All @@ -273,20 +273,24 @@ detail please see:

- Two-group comparison (e.g. differential expression) via *t*-test
- see `stats::t.test()`
- see vignette
`vignette("stat-two-group-comparison", package = "SomaDataIO")`
- see vignette: [Two-Group
Comparison](https://somalogic.github.io/SomaDataIO/articles/stat-two-group-comparison.html)
- Multi-group comparison (e.g. differential expression) via ANOVA
- see `stats::aov()`
- see vignette
`vignette("stat-three-group-analysis-anova", package = "SomaDataIO")`
- see vignette: [ANOVA Three-Group
Analysis](https://somalogic.github.io/SomaDataIO/articles/stat-three-group-analysis-anova.html)
- Binary classification
- see `stats::glm()`
- see vignette
`vignette("stat-binary-classification", package = "SomaDataIO")`
- see vignette: [Binary
Classification](https://somalogic.github.io/SomaDataIO/articles/stat-binary-classification.html)
- Linear regression
- see `stats::lm()`
- see vignette
`vignette("stat-linear-regression", package = "SomaDataIO")`
- see vignette: [Linear
Regression](https://somalogic.github.io/SomaDataIO/articles/stat-linear-regression.html)

Note that, in an effort to reduce dependencies, these articles are only
accessible via the `SomaDataIO` `pkgdown` website, and are not included
with the installed package.

------------------------------------------------------------------------

Expand Down
13 changes: 8 additions & 5 deletions vignettes/SomaDataIO.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ contributed packages from the Comprehensive R Archive Network (CRAN).
+ [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)

* Exporting data (Output)
+ write out a `soma_adat` object as a `*.adat` text file.
Expand All @@ -61,20 +61,23 @@ primary statistical analyses that are commonly performed on

- Two-group comparison (e.g. differential expression) via *t*-test
+ see `stats::t.test()`
+ see vignette `vignette("stat-two-group-comparison", package = "SomaDataIO")`
+ see vignette: [Two-Group Comparison](https://somalogic.github.io/SomaDataIO/articles/stat-two-group-comparison.html)

- Multi-group comparison (e.g. differential expression) via ANOVA
+ see `stats::aov()`
+ see vignette `vignette("stat-three-group-analysis-anova", package = "SomaDataIO")`
+ see vignette: [ANOVA Three-Group Analysis](https://somalogic.github.io/SomaDataIO/articles/stat-three-group-analysis-anova.html)

- Binary classification
+ see `stats::glm()`
+ see vignette `vignette("stat-binary-classification", package = "SomaDataIO")`
+ see vignette: [Binary Classification](https://somalogic.github.io/SomaDataIO/articles/stat-binary-classification.html)

- Linear regression
+ see `stats::lm()`
+ see vignette `vignette("stat-linear-regression", package = "SomaDataIO")`
+ see vignette: [Linear Regression](https://somalogic.github.io/SomaDataIO/articles/stat-linear-regression.html)

Note that, in an effort to reduce dependencies, these articles are only
accessible via the `SomaDataIO` `pkgdown` website, and are not included with the
installed package.

---------------------

Expand Down

0 comments on commit 5d8ee9b

Please sign in to comment.