Skip to content

Commit

Permalink
improve doc style
Browse files Browse the repository at this point in the history
  • Loading branch information
Yunuuuu committed Jul 11, 2024
1 parent da2bb73 commit fe1215c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -920,13 +920,13 @@ <h2 id="gganno"><code>gganno</code></h2>
<li><p><code>.column_names</code> and <code>.column_index</code>: the
column names (only applicable when names exist) and index of the
original data
(<code>only applicable when the original data is a matrix</code>).</p></li>
(<code>only applicable when the original data is a matrix</code>).</p></li>
<li><p><code>x</code> / <code>y</code>: indicating the x-axis (or
y-axis) coordinates. Don’t use <code>coord_flip</code> to flip
coordinates as it may disrupt internal operations.</p></li>
<li><p><code>value</code>: the actual matrix value of the annotation
matrix
(<code>only applicable when the original data is a matrix</code>).</p></li>
(<code>only applicable when the original data is a matrix</code>).</p></li>
</ul>
<p><code>gganno</code> can be seamlessly combined with both
<code>ggheat</code> and <code>ComplexHeatmap::Heatmap</code>, although
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -394,14 +394,14 @@ contain following columns:

- `.column_names` and `.column_index`: the column names (only applicable
when names exist) and index of the original data
(`only applicable when the original data is a matrix`).
(`only applicable when the original data is a matrix`).

- `x` / `y`: indicating the x-axis (or y-axis) coordinates. Don’t use
`coord_flip` to flip coordinates as it may disrupt internal
operations.

- `value`: the actual matrix value of the annotation matrix
(`only applicable when the original data is a matrix`).
(`only applicable when the original data is a matrix`).

`gganno` can be seamlessly combined with both `ggheat` and
`ComplexHeatmap::Heatmap`, although legends will not be extracted in the
Expand Down
6 changes: 2 additions & 4 deletions vignettes/eheat.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -306,14 +306,12 @@ contain following columns:
exist) and index of the original data.

- `.column_names` and `.column_index`: the column names (only applicable when
names exist) and index of the original data (`only applicable when
the original data is a matrix`).
names exist) and index of the original data (`only applicable when the original data is a matrix`).

- `x` / `y`: indicating the x-axis (or y-axis) coordinates. Don't use
`coord_flip` to flip coordinates as it may disrupt internal operations.

- `value`: the actual matrix value of the annotation matrix (`only applicable
when the original data is a matrix`).
- `value`: the actual matrix value of the annotation matrix (`only applicable when the original data is a matrix`).

`gganno` can be seamlessly combined with both `ggheat` and
`ComplexHeatmap::Heatmap`, although legends will not be extracted in the later
Expand Down

0 comments on commit fe1215c

Please sign in to comment.