Skip to content

Commit

Permalink
fix Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Yunuuuu committed Jun 26, 2024
1 parent 782069f commit 0172cd4
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 12 deletions.
2 changes: 1 addition & 1 deletion R/gganno.R
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
#' `ggplot(data, aes(.data$x))` / `ggplot(data, ggplot2::aes(y = .data$y))`.
#' The original matrix will be converted into a long-data.frame (`gganno` always
#' regard row as the observations) with following columns:
#' - `.slice`: the slice row (which = "row") or column (which = "column")
#' - `.slice`: the slice row (which = `"row"`) or column (which = `"column"`)
#' number.
#' - `.row_names` and `.column_names`: the row and column names of the original
#' matrix (only applicable when names exist).
Expand Down
5 changes: 2 additions & 3 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -915,8 +915,7 @@ <h2 id="gganno"><code>gganno</code></h2>
<li><code>.row_index</code> and <code>.column_index</code>: the row and
column index of the original matrix.</li>
<li><code>x</code> / <code>y</code>: indicating the x-axis (or y-axis)
coordinates. Don’t use [coord_flip][ggplot2::coord_flip] to flip
coordinates as it may disrupt internal operations.</li>
coordinates.</li>
<li><code>value</code>: the actual matrix value of the annotation
matrix.</li>
</ul>
Expand Down Expand Up @@ -1223,7 +1222,7 @@ <h2 id="sessioninfo">sessionInfo</h2>
<span id="cb37-20"><a href="#cb37-20" tabindex="-1"></a><span class="co">#&gt; [8] base </span></span>
<span id="cb37-21"><a href="#cb37-21" tabindex="-1"></a><span class="co">#&gt; </span></span>
<span id="cb37-22"><a href="#cb37-22" tabindex="-1"></a><span class="co">#&gt; other attached packages:</span></span>
<span id="cb37-23"><a href="#cb37-23" tabindex="-1"></a><span class="co">#&gt; [1] eheat_0.99.6 ggplot2_3.5.1 ComplexHeatmap_2.20.0</span></span>
<span id="cb37-23"><a href="#cb37-23" tabindex="-1"></a><span class="co">#&gt; [1] eheat_0.99.7 ggplot2_3.5.1 ComplexHeatmap_2.20.0</span></span>
<span id="cb37-24"><a href="#cb37-24" tabindex="-1"></a><span class="co">#&gt; </span></span>
<span id="cb37-25"><a href="#cb37-25" tabindex="-1"></a><span class="co">#&gt; loaded via a namespace (and not attached):</span></span>
<span id="cb37-26"><a href="#cb37-26" tabindex="-1"></a><span class="co">#&gt; [1] utf8_1.2.4 generics_0.1.3 tidyr_1.3.1 </span></span>
Expand Down
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,9 +388,7 @@ observations) with following columns.
original matrix (only applicable when names exist).
- `.row_index` and `.column_index`: the row and column index of the
original matrix.
- `x` / `y`: indicating the x-axis (or y-axis) coordinates. Don’t use
\[coord_flip\]\[ggplot2::coord_flip\] to flip coordinates as it may
disrupt internal operations.
- `x` / `y`: indicating the x-axis (or y-axis) coordinates.
- `value`: the actual matrix value of the annotation matrix.

`gganno` can be seamlessly combined with both `ggheat` and
Expand Down Expand Up @@ -747,7 +745,7 @@ sessionInfo()
#> [8] base
#>
#> other attached packages:
#> [1] eheat_0.99.6 ggplot2_3.5.1 ComplexHeatmap_2.20.0
#> [1] eheat_0.99.7 ggplot2_3.5.1 ComplexHeatmap_2.20.0
#>
#> loaded via a namespace (and not attached):
#> [1] utf8_1.2.4 generics_0.1.3 tidyr_1.3.1
Expand Down
2 changes: 1 addition & 1 deletion man/gganno.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 1 addition & 3 deletions vignettes/eheat.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -300,9 +300,7 @@ row as the observations) with following columns.
matrix (only applicable when names exist).
- `.row_index` and `.column_index`: the row and column index of the original
matrix.
- `x` / `y`: indicating the x-axis (or y-axis) coordinates. Don't use
[coord_flip][ggplot2::coord_flip] to flip coordinates as it may disrupt
internal operations.
- `x` / `y`: indicating the x-axis (or y-axis) coordinates.
- `value`: the actual matrix value of the annotation matrix.

`gganno` can be seamlessly combined with both `ggheat` and
Expand Down

0 comments on commit 0172cd4

Please sign in to comment.