Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Shixiang Wang (王诗翔) committed Jun 7, 2024
1 parent 2acb064 commit 01d1e93
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 4 deletions.
17 changes: 14 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,16 @@ conda install -c bioconda -c conda-forge r-sigminer

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.

## :question: QA

### How to install the `copynumber` package

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.

```r
remotes::install_github("ShixiangWang/copynumber")
```

## :paperclip: Citation

If you use **sigminer** in academic field, please cite one of the following papers.
Expand All @@ -157,7 +167,7 @@ library("spiralize")
library("ComplexHeatmap")
library("lubridate")
df <- cran_downloads("sigminer", from = "2019-07-01", to = "2023-03-29")
df <- cran_downloads("sigminer", from = "2019-07-01", to = "2024-06-07")
if (!is.null(df)) {
day_diff = as.double(df$date[nrow(df)] - df$date[1], "days")
Expand All @@ -178,7 +188,8 @@ if (!is.null(df)) {
spiral_highlight("2020-01-01", "2020-12-31", type = "line", gp = gpar(col = 2))
spiral_highlight("2021-01-01", "2021-12-31", type = "line", gp = gpar(col = 3))
spiral_highlight("2022-01-01", "2022-12-31", type = "line", gp = gpar(col = 4))
spiral_highlight("2023-01-01", "end", type = "line", gp = gpar(col = 4))
spiral_highlight("2023-01-01", "2023-12-31", type = "line", gp = gpar(col = 5))
spiral_highlight("2024-01-01", "end", type = "line", gp = gpar(col = 6))
s = current_spiral()
d = seq(15, 360, by = 30) %% 360
Expand All @@ -191,7 +202,7 @@ if (!is.null(df)) {
lgd = packLegend(
Legend(title = "Difference to\nyearly average", at = c("higher", "lower"),
legend_gp = gpar(fill = c("#D73027", "#313695"))),
Legend(title = "Year", type = "lines", at = 2019:2023,
Legend(title = "Year", type = "lines", at = 2019:2024,
legend_gp = gpar(col = 1:5))
)
draw(lgd, x = unit(1, "npc") + unit(10, "mm"), just = "left")
Expand Down
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,21 @@ organized and documented at
usage of a specific function `fun`, run `?fun` in your R console to see
its documentation.

## :question: QA

### How to install the `copynumber` package

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.

``` r
remotes::install_github("ShixiangWang/copynumber")
```

## :paperclip: Citation

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

![Alt](https://repobeats.axiom.co/api/embed/7cd2cf8a196dde9d8d1e13c9b23bc2f157d8254e.svg "Repobeats analytics image")
<figure>
<img
src="https://repobeats.axiom.co/api/embed/7cd2cf8a196dde9d8d1e13c9b23bc2f157d8254e.svg"
title="Repobeats analytics image" alt="Alt" />
<figcaption aria-hidden="true">Alt</figcaption>
</figure>
Binary file modified man/figures/README-unnamed-chunk-9-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 01d1e93

Please sign in to comment.