Skip to content

Commit

Permalink
adjusted docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eschen42 committed Dec 17, 2019
1 parent ce278fc commit ca31b44
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion inst/NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

* Enhancement https://github.com/HegemanLab/w4mclassfilter/issues/6 - "compute center for each treatment"
* Built with R 3.6.1 (2019-07-05) "Action of the Toes"

* Built with the command `R CMD build w4mclassfilter` to assure that vignettes are built as intended.

# CHANGES IN VERSION 0.98.14

Expand Down
5 changes: 3 additions & 2 deletions vignettes/w4mclassfilter.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ output:
fig_caption: yes
vignette: >
%\VignetteIndexEntry{Filter W4M data by sample class}
%\VignetteEngine{knitr::rmarkdown}
\usepackage[utf8]{inputenc}
\usepackage[all]{nowidow}
\widowpenalty10000
\clubpenalty10000
%\VignetteEngine{knitr::rmarkdown}
---

### Purpose of the `w4mclassfilter` package
Expand Down Expand Up @@ -48,6 +48,7 @@ or to address several data issues that may impede downstream statistical analysi
- The column for sorting `variableMetadata` or `sampleMetadata` may be specified or defaults to the first column.
- By default, the name of the first column `sampleMetadata` is set to `"sampleMetadata"`.
- The name of the first column `variableMetadata` is set to `"variableMetadata"`.
- An advanced option enables producing a "center" for each treatment in lieu of the samples for each treatment.

### How the `w4m_filter_by_sample_class` function is used

Expand Down Expand Up @@ -309,4 +310,4 @@ To support XCMS outside the context of Galaxy, `w4mclassfilter::w4m_filter_by_sa
- "centroid" - Return only treatment-centers computed for each treatment as the mean intensity for each feature.
- "median" - Return only treatment-centers computed for each treatment as the median intensity for each feature.
- "medoid" - Return only treatment-centers computed for each treatement as the sample most similar to the other samples, using distances computed in principal-components space.
- "none" - Return all samples; do not computing centers
- "none" - Return all samples; do not computing centers.

0 comments on commit ca31b44

Please sign in to comment.