stRoke/docs/index.html

162 lines
10 KiB
HTML
Raw Normal View History

2022-09-22 14:23:49 +02:00
<!DOCTYPE html>
<!-- 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">
2022-12-22 15:07:20 +01:00
<meta name="description" content="This is an R-toolbox of custom functions for convenient data management
and analysis in clinical health research and teaching.
The package is mainly collected for personal use, but any use beyond that is encouraged.
This package has migrated functions from the agdamsbo/daDoctoR-package, and new functions has been added.">
<title>Clinical stroke research toolbox • stRoke</title>
2022-09-22 14:23:49 +02:00
<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.1.3/bootstrap.min.css" rel="stylesheet">
<script src="deps/bootstrap-5.1.3/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous">
2022-12-22 15:07:20 +01:00
<!-- bootstrap-toc --><script src="https://cdn.jsdelivr.net/gh/afeld/bootstrap-toc@v1.0.1/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="pkgdown.js"></script><meta property="og:title" content="Clinical stroke research toolbox">
<meta property="og:description" content="This is an R-toolbox of custom functions for convenient data management
and analysis in clinical health research and teaching.
The package is mainly collected for personal use, but any use beyond that is encouraged.
This package has migrated functions from the agdamsbo/daDoctoR-package, and new functions has been added.">
2022-09-22 14:23:49 +02:00
<!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
<nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><div class="container">
<a class="navbar-brand me-2" href="index.html">stRoke</a>
2023-01-03 14:13:22 +01:00
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.23.1.1</small>
2022-09-22 14:23:49 +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">
<ul class="navbar-nav me-auto">
<li class="nav-item">
<a class="nav-link" href="reference/index.html">Reference</a>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown" role="button" aria-expanded="false" aria-haspopup="true" id="dropdown-articles">Articles</a>
<div class="dropdown-menu" aria-labelledby="dropdown-articles">
2023-01-04 14:45:37 +01:00
<a class="dropdown-item" href="articles/redcap.html">Simple REDCap workflow</a>
<a class="dropdown-item" href="articles/toolbox.html">Toolbox</a>
</div>
</li>
<li class="nav-item">
<a class="nav-link" href="news/index.html">Changelog</a>
2022-09-22 14:23:49 +02:00
</li>
</ul>
<form class="form-inline my-2 my-lg-0" role="search">
<input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="search.json" id="search-input" placeholder="Search for" autocomplete="off">
</form>
2022-12-22 15:07:20 +01:00
<ul class="navbar-nav">
<li class="nav-item">
<a class="external-link nav-link" href="https://github.com/agdamsbo/stRoke/" aria-label="github">
<span class="fab fa fab fa-github fa-lg"></span>
</a>
</li>
</ul>
2022-09-22 14:23:49 +02:00
</div>
</div>
</nav><div class="container template-home">
<div class="row">
<main id="main" class="col-md-9">
<div class="section level1">
2022-09-22 15:22:09 +02:00
<div class="page-header"><h1 id="stroke-package-">stRoke package <img src="reference/figures/hexlogo.png" align="right"><a class="anchor" aria-label="anchor" href="#stroke-package-"></a>
2022-09-22 14:23:49 +02:00
</h1></div>
2023-01-03 14:20:24 +01:00
<p>This is an R-toolbox of custom functions for convenient data management and analysis in clinical health research and teaching. The package is mainly collected for personal use, but any use beyond that is encouraged. This package has migrated functions from the agdamsbo/daDoctoR-package, and new functions has been added.</p>
2022-09-23 19:20:15 +02:00
</div>
<div class="section level1">
<h1 id="a-few-notes">A few notes<a class="anchor" aria-label="anchor" href="#a-few-notes"></a>
</h1>
<p>The function <code><a href="reference/generic_stroke.html">generic_stroke()</a></code>can be used with <code>data(talos)</code> or a custom data set to illustrate the classic analysis of mRS outcome from stroke trials.</p>
2023-01-03 14:13:22 +01:00
<p>In documenting and testing the package, I have used <a href="https://beta.openai.com/overview" class="external-link">OpenAIs</a> chatgpt with <a href="https://jameshwade.github.io/gpttools/" class="external-link">gpttools</a>. The chatgpt is an interesting tool, that is in no way perfect, but it helps with tedious tasks. Both <code>gpttools</code> and <a href="https://michelnivard.github.io/gptstudio/" class="external-link"><code>gptstudio</code></a> are interesting implementations in R and RStudio.</p>
</div>
<div class="section level1">
2022-11-28 10:01:14 +01:00
<h1 id="source">Source<a class="anchor" aria-label="anchor" href="#source"></a>
2022-09-23 19:20:15 +02:00
</h1>
2022-09-26 13:59:05 +02:00
<p>This package is <a href="https://github.com/agdamsbo/stRoke" class="external-link">shared on GitHub</a>, and you are very welcome to contribute by opening an issue or a pull request.</p>
2022-11-28 10:01:14 +01:00
</div>
<div class="section level1">
<h1 id="installation">Installation<a class="anchor" aria-label="anchor" href="#installation"></a>
</h1>
<p>The package can be installed from GitHub:</p>
<pre><code><span><span class="fu">remotes</span><span class="fu">::</span><span class="fu"><a href="https://remotes.r-lib.org/reference/install_github.html" class="external-link">install_github</a></span><span class="op">(</span><span class="st">"agdamsbo/stRoke"</span><span class="op">)</span></span></code></pre>
2022-09-22 14:23:49 +02:00
</div>
2022-12-22 15:07:20 +01:00
</main><aside class="col-md-3"><div class="links">
<h2 data-toc-skip>Links</h2>
<ul class="list-unstyled">
<li><a href="https://github.com/agdamsbo/stRoke/" class="external-link">Browse source code</a></li>
<li><a href="https://github.com/agdamsbo/stRoke/issues" class="external-link">Report a bug</a></li>
</ul>
</div>
<div class="license">
2022-09-22 14:23:49 +02:00
<h2 data-toc-skip>License</h2>
<ul class="list-unstyled">
<li><a href="https://www.r-project.org/Licenses/GPL-3" class="external-link">GPL-3</a></li>
</ul>
</div>
<div class="citation">
<h2 data-toc-skip>Citation</h2>
<ul class="list-unstyled">
<li><a href="authors.html#citation">Citing stRoke</a></li>
</ul>
</div>
<div class="developers">
<h2 data-toc-skip>Developers</h2>
<ul class="list-unstyled">
<li>Andreas Gammelgaard Damsbo <br><small class="roles"> Author, maintainer </small> <a href="https://orcid.org/0000-0002-7559-1154" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
</ul>
</div>
<div class="dev-status">
<h2 data-toc-skip>Dev status</h2>
<ul class="list-unstyled">
<li><a href="https://github.com/agdamsbo/stRoke/actions/workflows/R-CMD-check.yaml" class="external-link"><img src="https://github.com/agdamsbo/stRoke/actions/workflows/R-CMD-check.yaml/badge.svg" alt="Github Actions"></a></li>
<li><a href="https://github.com/agdamsbo/stRoke/actions/workflows/pages/pages-build-deployment" class="external-link"><img src="https://github.com/agdamsbo/stRoke/actions/workflows/pages/pages-build-deployment/badge.svg" alt="Page deployed"></a></li>
<li><a href="https://codecov.io/github/agdamsbo/stRoke" class="external-link"><img src="https://codecov.io/github/agdamsbo/stRoke/branch/main/graph/badge.svg?token=U0RBZYSKG5" alt="codecov"></a></li>
2022-09-22 14:23:49 +02:00
</ul>
</div>
</aside>
</div>
<footer><div class="pkgdown-footer-left">
<p></p>
<p>Developed by Andreas Gammelgaard Damsbo.</p>
</div>
<div class="pkgdown-footer-right">
<p></p>
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
2022-09-22 14:23:49 +02:00
</div>
</footer>
</div>
</body>
</html>