Skip to content

Commit

Permalink
README.md regenerated
Browse files Browse the repository at this point in the history
  • Loading branch information
kassambara committed Oct 29, 2024
1 parent 71d1e2d commit 52d7542
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 24 deletions.
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

## Minor changes

- R-ADDICT website is no longer live, so updating links in README (#622)

## Bug fixes

- Fixing Rd cross-references issue in the documentation (@HenningLorenzen-ext-bayer, #663). RD `\link{}` targets missing package added in the following Rd files:
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ knitr::opts_chunk$set(
```


[![R build status](/~https://github.com/kassambara/survminer/workflows/R-CMD-check/badge.svg)](/~https://github.com/kassambara/survminer/actions)
[![R-CMD-check](/~https://github.com/kassambara/survminer/actions/workflows/R-CMD-check.yaml/badge.svg)](/~https://github.com/kassambara/survminer/actions/workflows/R-CMD-check.yaml)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/survminer)](https://cran.r-project.org/package=survminer)
[![Downloads](https://cranlogs.r-pkg.org/badges/survminer)](https://cran.r-project.org/package=survminer)
[![Total Downloads](https://cranlogs.r-pkg.org/badges/grand-total/survminer?color=orange)](https://cran.r-project.org/package=survminer)
Expand Down
39 changes: 16 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[![R build
status](/~https://github.com/kassambara/survminer/workflows/R-CMD-check/badge.svg)](/~https://github.com/kassambara/survminer/actions)
[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/survminer)](https://cran.r-project.org/package=survminer)
[![R-CMD-check](/~https://github.com/kassambara/survminer/actions/workflows/R-CMD-check.yaml/badge.svg)](/~https://github.com/kassambara/survminer/actions/workflows/R-CMD-check.yaml)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/survminer)](https://cran.r-project.org/package=survminer)
[![Downloads](https://cranlogs.r-pkg.org/badges/survminer)](https://cran.r-project.org/package=survminer)
[![Total
Downloads](https://cranlogs.r-pkg.org/badges/grand-total/survminer?color=orange)](https://cran.r-project.org/package=survminer)
Expand All @@ -27,8 +26,7 @@ Downloads](https://cranlogs.r-pkg.org/badges/grand-total/survminer?color=orange)
curves](#uber-platinum-premium-customized-survival-curves)
- [Blog posts](#blog-posts)

survminer: Survival Analysis and Visualization
==============================================
# survminer: Survival Analysis and Visualization

The **survminer** R package provides functions for facilitating
**survival analysis** and **visualization**.
Expand All @@ -45,21 +43,21 @@ categories as follow.
table, the cumulative number of events table and the cumulative
number of censored subjects table.

- **arrange\_ggsurvplots**(): Arranges multiple ggsurvplots on the
same page.
- **arrange_ggsurvplots**(): Arranges multiple ggsurvplots on the same
page.

- **ggsurvevents**(): Plots the distribution of event’s times.

- **surv\_summary**(): Summary of a survival curve. Compared to the
default summary() function, surv\_summary() creates a data frame
- **surv_summary**(): Summary of a survival curve. Compared to the
default summary() function, surv_summary() creates a data frame
containing a nice summary from survfit results.

- **surv\_cutpoint**(): Determines the optimal cutpoint for one or
- **surv_cutpoint**(): Determines the optimal cutpoint for one or
multiple continuous variables at once. Provides a value of a
cutpoint that correspond to the most significant relation with
survival.

- **pairwise\_survdiff**(): Multiple comparisons of survival curves.
- **pairwise_survdiff**(): Multiple comparisons of survival curves.
Calculate pairwise comparisons between group levels with corrections
for multiple testing.

Expand Down Expand Up @@ -106,13 +104,11 @@ categories as follow.

<br/>

> Find out more at
> <a href="https://rpkgs.datanovia.com/survminer/" class="uri">https://rpkgs.datanovia.com/survminer/</a>,
> and check out the documentation and usage examples of each of the
> functions in survminer package.
> Find out more at <https://rpkgs.datanovia.com/survminer/>, and check
> out the documentation and usage examples of each of the functions in
> survminer package.
Installation and loading
------------------------
## Installation and loading

Install from [CRAN](https://cran.r-project.org/package=survminer) as
follow:
Expand All @@ -135,8 +131,7 @@ Load survminer:
library("survminer")
```

ggsurvplot: Drawing survival curves
-----------------------------------
## ggsurvplot: Drawing survival curves

### Fitting survival curves

Expand Down Expand Up @@ -327,8 +322,7 @@ ggsurv

![](tools/README-ggplot2-uber-platinium-customized-survival-plot-1.png)

Uber platinum premium customized survival curves
------------------------------------------------
## Uber platinum premium customized survival curves

``` r
# Using specific fonts for risk table and ncensor plots
Expand Down Expand Up @@ -361,8 +355,7 @@ print(ggsurv)

![](tools/README-ggplot2-uber-platinium-premium-customized-survival-plot-1.png)

Blog posts
----------
## Blog posts

- M. Kosiński. January 2017. [Weighted Log-rank
Tests](https://rpkgs.datanovia.com/survminer/articles/Specifiying_weights_in_log-rank_comparisons.html)
Expand Down
Binary file modified tools/README-ggplot2-basic-survival-plot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified tools/README-ggplot2-customized-survival-plot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified tools/README-ggplot2-more-customized-survival-plot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified tools/README-ggplot2-uber-customized-survival-plot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 52d7542

Please sign in to comment.