Skip to content

Commit 4693c68

Browse files
committed
Minor updates to documentation for CRAN
1 parent dbd7099 commit 4693c68

3 files changed

Lines changed: 12 additions & 12 deletions

File tree

R/methods-TxpResult-plot.R

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@
2323
#' when `TRUE`
2424
#' @param ... Passed to [pieGridGrob] when plotting ToxPi and to pointsGrob
2525
#' when plotting ranks
26-
#' @param ncol Number of columns for [ggplot2] ToxPi profiles
26+
#' @param ncol Number of columns for ggplot2 ToxPi profiles
2727
#' @param bgColor,borderColor,sliceBorderColor,sliceValueColor,sliceLineColor
28-
#' Various color options when creating [ggplot2] ToxPi profiles. Set to NULL
28+
#' Various color options when creating ggplot2 ToxPi profiles. Set to NULL
2929
#' for no color
30-
#' @param showMissing Boolean for coloring data missingness in [ggplot2]
30+
#' @param showMissing Boolean for coloring data missingness in ggplot2
3131
#' ToxPi profiles
32-
#' @param showCenter Boolean for showing inner circle in [ggplot2] ToxPi
32+
#' @param showCenter Boolean for showing inner circle in ggplot2 ToxPi
3333
#' profiles. When set to False overrides showMissing
3434
#'
3535
#' @details
@@ -44,7 +44,7 @@
4444
#' If the labels are running of the device, the top or bottom margins can be
4545
#' increased with the `margins` parameter.
4646
#'
47-
#' ToxPi profiles can also be plotted using the [ggplot2] package.
47+
#' ToxPi profiles can also be plotted using the ggplot2 package.
4848
#'
4949
#' @template roxgn-loadExamples
5050
#' @template roxgn-calcTxpModel

man/TxpResult-plot.Rd

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vignettes/introduction.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ This document introduces ToxPi and describes how to use the `toxpiR` package to
4646

4747
## What is ToxPi?
4848

49-
The Toxicological Prioritization Index (ToxPi) is a statistical modeling framework that allows transparent integration and visualization of data across disparate sources (i.e. multimodal or multiscale information). This framework aggregates related features into scored ‘slices’, rescales individual slice scores to range 0–1, and then develops an overall score for each sample using a weighted model. The slice weights can be interpreted as the "importance" of categorized features when predicting sample scores and associated ranks. The resulting scores for each sample are visualized as ToxPi profiles (see image below). Slice weights are represented as the arc-width, slice scores are represented as the radius, and the overall sample scores are represented by the combination of slice weights and radii. These visualizations allow for quick comparison of overall feature importance, feature impacts driving a specific sample, relative impact ranking of common features between samples, and overall ranking between samples. As a flexible method capable of integrating data from any source, it has been [applied](https://scholar.google.com/scholar?start=5&hl=en&as_sdt=0,34&sciodt=0,34&cites=14315759707117183281,8409987751811922970,6830405381891567320,6660731247750930378,6264826653350493071,6008919238370157052,5228323847718230279,14470107422640831138) to problems in several different fields. Additional information is linked from [toxpi.org](https://toxpi.org).
49+
The Toxicological Prioritization Index (ToxPi) is a statistical modeling framework that allows transparent integration and visualization of data across disparate sources (i.e. multimodal or multiscale information). This framework aggregates related features into scored ‘slices’, rescales individual slice scores to range 0–1, and then develops an overall score for each sample using a weighted model. The slice weights can be interpreted as the "importance" of categorized features when predicting sample scores and associated ranks. The resulting scores for each sample are visualized as ToxPi profiles (see image below). Slice weights are represented as the arc-width, slice scores are represented as the radius, and the overall sample scores are represented by the combination of slice weights and radii. These visualizations allow for quick comparison of overall feature importance, feature impacts driving a specific sample, relative impact ranking of common features between samples, and overall ranking between samples. As a flexible method capable of integrating data from any source, it has been applied to problems in several different fields. Additional information is linked from [toxpi.org](https://toxpi.org).
5050

5151
<center>
5252
![](embeddedFigures/txp_explain1.png){width=700px}
@@ -230,7 +230,7 @@ Two paths exist for visualization, **ggplot** methods and **grid** methods. The
230230

231231
<div >
232232
<h3>ggPlot</h3>
233-
* Examples shown in this vignette produce a "look-and-feel" that is closer to the graphics output of the familiar [ToxPi GUI](www.toxpi.org)
233+
* Examples shown in this vignette produce a "look-and-feel" that is closer to the graphics output of the familiar [ToxPi GUI](https://toxpi.org)
234234
* Aesthetics are easy to customize
235235
* Includes missing data visuals (center circle à la ToxPi GUI output)
236236
</div>

0 commit comments

Comments
 (0)