2023-06-30 10:04:32 +02:00
<!DOCTYPE html>
2024-10-10 14:22:20 +02:00
<!-- Generated by pkgdown: do not edit by hand --> < html lang = "en" > < head > < meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" > < meta charset = "utf-8" > < meta http-equiv = "X-UA-Compatible" content = "IE=edge" > < meta name = "viewport" content = "width=device-width, initial-scale=1, shrink-to-fit=no" > < title > Calculates the probability of winning — win_prob • stRoke< / title > <!-- favicons --> < link rel = "icon" type = "image/png" sizes = "16x16" href = "../favicon-16x16.png" > < link rel = "icon" type = "image/png" sizes = "32x32" href = "../favicon-32x32.png" > < link rel = "apple-touch-icon" type = "image/png" sizes = "180x180" href = "../apple-touch-icon.png" > < link rel = "apple-touch-icon" type = "image/png" sizes = "120x120" href = "../apple-touch-icon-120x120.png" > < link rel = "apple-touch-icon" type = "image/png" sizes = "76x76" href = "../apple-touch-icon-76x76.png" > < link rel = "apple-touch-icon" type = "image/png" sizes = "60x60" href = "../apple-touch-icon-60x60.png" > < script src = "../deps/jquery-3.6.0/jquery-3.6.0.min.js" > < / script > < meta name = "viewport" content = "width=device-width, initial-scale=1, shrink-to-fit=no" > < link href = "../deps/bootstrap-5.3.1/bootstrap.min.css" rel = "stylesheet" > < script src = "../deps/bootstrap-5.3.1/bootstrap.bundle.min.js" > < / script > < link href = "../deps/font-awesome-6.4.2/css/all.min.css" rel = "stylesheet" > < link href = "../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel = "stylesheet" > < script src = "../deps/headroom-0.11.0/headroom.min.js" > < / script > < script src = "../deps/headroom-0.11.0/jQuery.headroom.min.js" > < / script > < script src = "../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js" > < / script > < script src = "../deps/clipboard.js-2.0.11/clipboard.min.js" > < / script > < script src = "../deps/search-1.0.0/autocomplete.jquery.min.js" > < / script > < script src = "../deps/search-1.0.0/fuse.min.js" > < / script > < script src = "../deps/search-1.0.0/mark.min.js" > < / script > <!-- pkgdown --> < script src = "../pkgdown.js" > < / script > < meta property = "og:title" content = "Calculates the probability of winning — win_prob" > < meta name = "description" content = "Calculates the probability of winning ( winP ) . In the referenced
2023-06-30 10:04:32 +02:00
article Zou et al (2022) proposes a method for calculating probability of
2024-10-10 14:22:20 +02:00
winning with a confidence interval an p-value testing.">< meta property = "og:description" content = "Calculates the probability of winning ( winP ) . In the referenced
2023-06-30 10:04:32 +02:00
article Zou et al (2022) proposes a method for calculating probability of
2024-10-10 14:22:20 +02:00
winning with a confidence interval an p-value testing.">< meta property = "og:image" content = "https://agdamsbo.github.io/stRoke/logo.png" > < / head > < body >
2023-06-30 10:04:32 +02:00
< a href = "#main" class = "visually-hidden-focusable" > Skip to contents< / a >
2024-10-10 14:22:20 +02:00
< nav class = "navbar navbar-expand-lg fixed-top bg-light" data-bs-theme = "light" aria-label = "Site navigation" > < div class = "container" >
2023-06-30 10:04:32 +02:00
< a class = "navbar-brand me-2" href = "../index.html" > stRoke< / a >
2024-10-10 14:22:20 +02:00
< small class = "nav-text text-muted me-auto" data-bs-toggle = "tooltip" data-bs-placement = "bottom" title = "" > 24.10.1< / small >
2023-06-30 10:04:32 +02:00
< button class = "navbar-toggler" type = "button" data-bs-toggle = "collapse" data-bs-target = "#navbar" aria-controls = "navbar" aria-expanded = "false" aria-label = "Toggle navigation" >
< span class = "navbar-toggler-icon" > < / span >
< / button >
< div id = "navbar" class = "collapse navbar-collapse ms-3" >
2024-10-10 14:22:20 +02:00
< ul class = "navbar-nav me-auto" > < li class = "active nav-item" > < a class = "nav-link" href = "../reference/index.html" > Reference< / a > < / li >
2023-06-30 10:04:32 +02:00
< li class = "nav-item dropdown" >
2024-10-10 14:22:20 +02:00
< button class = "nav-link dropdown-toggle" type = "button" id = "dropdown-articles" data-bs-toggle = "dropdown" aria-expanded = "false" aria-haspopup = "true" > Articles< / button >
< ul class = "dropdown-menu" aria-labelledby = "dropdown-articles" > < li > < a class = "dropdown-item" href = "../articles/toolbox.html" > Toolbox< / a > < / li >
< / ul > < / li >
< li class = "nav-item" > < a class = "nav-link" href = "../news/index.html" > Changelog< / a > < / li >
< / ul > < ul class = "navbar-nav" > < li class = "nav-item" > < form class = "form-inline" role = "search" >
< input class = "form-control" type = "search" name = "search-input" id = "search-input" autocomplete = "off" aria-label = "Search site" placeholder = "Search for" data-search-index = "../search.json" > < / form > < / li >
< li class = "nav-item" > < a class = "external-link nav-link" href = "https://github.com/agdamsbo/stRoke/" aria-label = "GitHub" > < span class = "fa fab fa-github fa-lg" > < / span > < / a > < / li >
2023-06-30 10:04:32 +02:00
< / ul > < / div >
2024-10-10 14:22:20 +02:00
2023-06-30 10:04:32 +02:00
< / div >
< / nav > < div class = "container template-reference-topic" >
< div class = "row" >
< main id = "main" class = "col-md-9" > < div class = "page-header" >
< img src = "../logo.png" class = "logo" alt = "" > < h1 > Calculates the probability of winning< / h1 >
2024-10-10 14:22:20 +02:00
< small class = "dont-index" > Source: < a href = "https://github.com/agdamsbo/stRoke/blob/main/R/win_prob.R" class = "external-link" > < code > R/win_prob.R< / code > < / a > < / small >
2023-06-30 10:04:32 +02:00
< div class = "d-none name" > < code > win_prob.Rd< / code > < / div >
< / div >
< div class = "ref-description section level2" >
< p > Calculates the probability of winning (winP). In the referenced
article Zou et al (2022) proposes a method for calculating probability of
winning with a confidence interval an p-value testing.< / p >
< / div >
< div class = "section level2" >
< h2 id = "ref-usage" > Usage< a class = "anchor" aria-label = "anchor" href = "#ref-usage" > < / a > < / h2 >
< div class = "sourceCode" > < pre class = "sourceCode r" > < code > < span > < span class = "fu" > win_prob< / span > < span class = "op" > (< / span > < / span >
< span > < span class = "va" > data< / span > ,< / span >
< span > response < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,< / span >
< span > group < span class = "op" > =< / span > < span class = "cn" > NULL< / span > ,< / span >
< span > alpha < span class = "op" > =< / span > < span class = "fl" > 0.05< / span > ,< / span >
< span > beta < span class = "op" > =< / span > < span class = "fl" > 0.2< / span > ,< / span >
< span > group.ratio < span class = "op" > =< / span > < span class = "fl" > 1< / span > ,< / span >
< span > sample.size < span class = "op" > =< / span > < span class = "cn" > FALSE< / span > ,< / span >
< span > print.tables < span class = "op" > =< / span > < span class = "cn" > FALSE< / span > ,< / span >
< span > dec < span class = "op" > =< / span > < span class = "fl" > 3< / span > < / span >
< span > < span class = "op" > )< / span > < / span > < / code > < / pre > < / div >
< / div >
< div class = "section level2" >
< h2 id = "source" > Source< a class = "anchor" aria-label = "anchor" href = "#source" > < / a > < / h2 >
< p > < a href = "https://doi.org/10.1161/STROKEAHA.121.037744" class = "external-link" > doi:10.1161/STROKEAHA.121.037744< / a > < / p >
< / div >
< div class = "section level2" >
< h2 id = "arguments" > Arguments< a class = "anchor" aria-label = "anchor" href = "#arguments" > < / a > < / h2 >
2024-10-10 14:22:20 +02:00
< dl > < dt id = "arg-data" > data< a class = "anchor" aria-label = "anchor" href = "#arg-data" > < / a > < / dt >
2023-06-30 10:04:32 +02:00
< dd > < p > A data frame containing the response and group variable.< / p > < / dd >
2024-10-10 14:22:20 +02:00
< dt id = "arg-response" > response< a class = "anchor" aria-label = "anchor" href = "#arg-response" > < / a > < / dt >
2023-06-30 10:04:32 +02:00
< dd > < p > The name of the response variable.
Takes first column if empty.< / p > < / dd >
2024-10-10 14:22:20 +02:00
< dt id = "arg-group" > group< a class = "anchor" aria-label = "anchor" href = "#arg-group" > < / a > < / dt >
2023-06-30 10:04:32 +02:00
< dd > < p > The name of the group variable.
Takes second column if empty.< / p > < / dd >
2024-10-10 14:22:20 +02:00
< dt id = "arg-alpha" > alpha< a class = "anchor" aria-label = "anchor" href = "#arg-alpha" > < / a > < / dt >
2023-06-30 10:04:32 +02:00
< dd > < p > The alpha level for the hypothesis test. Default is 0.05.< / p > < / dd >
2024-10-10 14:22:20 +02:00
< dt id = "arg-beta" > beta< a class = "anchor" aria-label = "anchor" href = "#arg-beta" > < / a > < / dt >
2023-06-30 10:04:32 +02:00
< dd > < p > The beta level for the sample size calculation. Default is 0.2.< / p > < / dd >
2024-10-10 14:22:20 +02:00
< dt id = "arg-group-ratio" > group.ratio< a class = "anchor" aria-label = "anchor" href = "#arg-group-ratio" > < / a > < / dt >
2023-06-30 10:04:32 +02:00
< dd > < p > The ratio of group sizes. Default is 1.< / p > < / dd >
2024-10-10 14:22:20 +02:00
< dt id = "arg-sample-size" > sample.size< a class = "anchor" aria-label = "anchor" href = "#arg-sample-size" > < / a > < / dt >
2023-06-30 10:04:32 +02:00
< dd > < p > Flag to include sample size calculation. Default is FALSE.< / p > < / dd >
2024-10-10 14:22:20 +02:00
< dt id = "arg-print-tables" > print.tables< a class = "anchor" aria-label = "anchor" href = "#arg-print-tables" > < / a > < / dt >
2023-06-30 10:04:32 +02:00
< dd > < p > Flag to print cumulative tables. Default is FALSE.< / p > < / dd >
2024-10-10 14:22:20 +02:00
< dt id = "arg-dec" > dec< a class = "anchor" aria-label = "anchor" href = "#arg-dec" > < / a > < / dt >
2023-06-30 10:04:32 +02:00
< dd > < p > Numeric for decimals to print. Default is 3.< / p > < / dd >
< / dl > < / div >
< div class = "section level2" >
< h2 id = "value" > Value< a class = "anchor" aria-label = "anchor" href = "#value" > < / a > < / h2 >
2024-10-10 14:22:20 +02:00
< p > A list containing the win_prob statistics.< / p >
2023-06-30 10:04:32 +02:00
< / div >
< div class = "section level2" >
< h2 id = "ref-examples" > Examples< a class = "anchor" aria-label = "anchor" href = "#ref-examples" > < / a > < / h2 >
< div class = "sourceCode" > < pre class = "sourceCode r" > < code > < span class = "r-in" > < span > < span class = "fu" > win_prob< / span > < span class = "op" > (< / span > data< span class = "op" > =< / span > < span class = "fu" > stRoke< / span > < span class = "fu" > ::< / span > < span class = "va" > < a href = "talos.html" > talos< / a > < / span > ,response< span class = "op" > =< / span > < span class = "st" > "mrs_6"< / span > ,group< span class = "op" > =< / span > < span class = "st" > "rtreat"< / span > < span class = "op" > )< / span > < / span > < / span >
< span class = "r-out co" > < span class = "r-pr" > #> < / span > Zou et al's winP (doi: 10.1161/STROKEAHA.121.037744) < / span >
< span class = "r-out co" > < span class = "r-pr" > #> < / span > < / span >
< span class = "r-out co" > < span class = "r-pr" > #> < / span > Probability of a random observation in Placebo group < / span >
< span class = "r-out co" > < span class = "r-pr" > #> < / span > will have a higher response score than a random< / span >
< span class = "r-out co" > < span class = "r-pr" > #> < / span > observation in Active group:< / span >
< span class = "r-out co" > < span class = "r-pr" > #> < / span > < / span >
< span class = "r-out co" > < span class = "r-pr" > #> < / span > winP: 0.400 (0.612, 0.372) p=0.0125< / span >
< span class = "r-out co" > < span class = "r-pr" > #> < / span > --------------------------------------------< / span >
< span class = "r-out co" > < span class = "r-pr" > #> < / span > < / span >
< span class = "r-out co" > < span class = "r-pr" > #> < / span > The numbers needed to treat (NNT) are: -9< / span >
< span class = "r-out co" > < span class = "r-pr" > #> < / span > < / span >
< span class = "r-out co" > < span class = "r-pr" > #> < / span > < / span >
< span class = "r-out co" > < span class = "r-pr" > #> < / span > < / span >
< / code > < / pre > < / div >
< / div >
2024-10-10 14:22:20 +02:00
< / main > < aside class = "col-md-3" > < nav id = "toc" aria-label = "Table of contents" > < h2 > On this page< / h2 >
2023-06-30 10:04:32 +02:00
< / nav > < / aside > < / div >
< footer > < div class = "pkgdown-footer-left" >
2024-10-10 14:22:20 +02:00
< p > Developed by Andreas Gammelgaard Damsbo.< / p >
2023-06-30 10:04:32 +02:00
< / div >
< div class = "pkgdown-footer-right" >
2024-10-10 14:22:20 +02:00
< p > Site built with < a href = "https://pkgdown.r-lib.org/" class = "external-link" > pkgdown< / a > 2.1.1.< / p >
2023-06-30 10:04:32 +02:00
< / div >
< / footer > < / div >
2024-10-10 14:22:20 +02:00
2023-06-30 10:04:32 +02:00
< / body > < / html >
