Skip to content

Commit 01d1e93

Browse files
author
Shixiang Wang (王诗翔)
committed
update readme
1 parent 2acb064 commit 01d1e93

File tree

3 files changed

+35
-4
lines changed

3 files changed

+35
-4
lines changed

README.Rmd

+14-3
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,16 @@ conda install -c bioconda -c conda-forge r-sigminer
135135

136136
A complete documentation of **sigminer** can be read online at <https://shixiangwang.github.io/sigminer-book/>. All functions are well organized and documented at <https://shixiangwang.github.io/sigminer/reference/index.html>. For usage of a specific function `fun`, run `?fun` in your R console to see its documentation.
137137

138+
## :question: QA
139+
140+
### How to install the `copynumber` package
141+
142+
For some extra features provided by **sigminer**, **copynumber** package is required. Due to the removal of the **copynumber** package from Bioc, I had to remove it from the dependencies in v2.2.0. You can install the package from <https://github.com/shixiangwang/copynumber/>. It is generally recommended as I have added some features, although other forks of this package exist on GitHub.
143+
144+
```r
145+
remotes::install_github("ShixiangWang/copynumber")
146+
```
147+
138148
## :paperclip: Citation
139149

140150
If you use **sigminer** in academic field, please cite one of the following papers.
@@ -157,7 +167,7 @@ library("spiralize")
157167
library("ComplexHeatmap")
158168
library("lubridate")
159169
160-
df <- cran_downloads("sigminer", from = "2019-07-01", to = "2023-03-29")
170+
df <- cran_downloads("sigminer", from = "2019-07-01", to = "2024-06-07")
161171
162172
if (!is.null(df)) {
163173
day_diff = as.double(df$date[nrow(df)] - df$date[1], "days")
@@ -178,7 +188,8 @@ if (!is.null(df)) {
178188
spiral_highlight("2020-01-01", "2020-12-31", type = "line", gp = gpar(col = 2))
179189
spiral_highlight("2021-01-01", "2021-12-31", type = "line", gp = gpar(col = 3))
180190
spiral_highlight("2022-01-01", "2022-12-31", type = "line", gp = gpar(col = 4))
181-
spiral_highlight("2023-01-01", "end", type = "line", gp = gpar(col = 4))
191+
spiral_highlight("2023-01-01", "2023-12-31", type = "line", gp = gpar(col = 5))
192+
spiral_highlight("2024-01-01", "end", type = "line", gp = gpar(col = 6))
182193
183194
s = current_spiral()
184195
d = seq(15, 360, by = 30) %% 360
@@ -191,7 +202,7 @@ if (!is.null(df)) {
191202
lgd = packLegend(
192203
Legend(title = "Difference to\nyearly average", at = c("higher", "lower"),
193204
legend_gp = gpar(fill = c("#D73027", "#313695"))),
194-
Legend(title = "Year", type = "lines", at = 2019:2023,
205+
Legend(title = "Year", type = "lines", at = 2019:2024,
195206
legend_gp = gpar(col = 1:5))
196207
)
197208
draw(lgd, x = unit(1, "npc") + unit(10, "mm"), just = "left")

README.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,21 @@ organized and documented at
110110
usage of a specific function `fun`, run `?fun` in your R console to see
111111
its documentation.
112112

113+
## :question: QA
114+
115+
### How to install the `copynumber` package
116+
117+
For some extra features provided by **sigminer**, **copynumber** package
118+
is required. Due to the removal of the **copynumber** package from Bioc,
119+
I had to remove it from the dependencies in v2.2.0. You can install the
120+
package from <https://github.com/shixiangwang/copynumber/>. It is
121+
generally recommended as I have added some features, although other
122+
forks of this package exist on GitHub.
123+
124+
``` r
125+
remotes::install_github("ShixiangWang/copynumber")
126+
```
127+
113128
## :paperclip: Citation
114129

115130
If you use **sigminer** in academic field, please cite one of the
@@ -198,4 +213,9 @@ MIT © 2018 Anand Mayakonda
198213
Sigminer v1-v2 are supported by [**Cancer Biology
199214
Group**](https://github.com/XSLiuLab) **@ShanghaiTech**
200215

201-
![Alt](https://repobeats.axiom.co/api/embed/7cd2cf8a196dde9d8d1e13c9b23bc2f157d8254e.svg "Repobeats analytics image")
216+
<figure>
217+
<img
218+
src="https://repobeats.axiom.co/api/embed/7cd2cf8a196dde9d8d1e13c9b23bc2f157d8254e.svg"
219+
title="Repobeats analytics image" alt="Alt" />
220+
<figcaption aria-hidden="true">Alt</figcaption>
221+
</figure>
142 KB
Loading

0 commit comments

Comments
 (0)