mirror of
https://github.com/agdamsbo/stRoke.git
synced 2024-11-22 13:00:23 +01:00
226 lines
19 KiB
HTML
226 lines
19 KiB
HTML
<!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"><title>Changelog • 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="Changelog"><meta property="og:image" content="https://agdamsbo.github.io/stRoke/logo.png"></head><body>
|
||
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
||
|
||
|
||
<nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">
|
||
|
||
<a class="navbar-brand me-2" href="../index.html">stRoke</a>
|
||
|
||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">24.10.1</small>
|
||
|
||
|
||
<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">
|
||
<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="active 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>
|
||
</ul></div>
|
||
|
||
|
||
</div>
|
||
</nav><div class="container template-news">
|
||
<div class="row">
|
||
<main id="main" class="col-md-9"><div class="page-header">
|
||
<img src="../logo.png" class="logo" alt=""><h1>Changelog</h1>
|
||
<small>Source: <a href="https://github.com/agdamsbo/stRoke/blob/main/NEWS.md" class="external-link"><code>NEWS.md</code></a></small>
|
||
</div>
|
||
|
||
<div class="section level2">
|
||
<h2 class="pkg-version" data-toc-text="24.10.1" id="stroke-24101">stRoke 24.10.1<a class="anchor" aria-label="anchor" href="#stroke-24101"></a></h2>
|
||
<p>This version marks a significant change in the contents and focus of this package. Going forward I will include functions with a focus on handling clinical trial data from my own stroke research. Other functions for general data management an project management has been migrated to the <a href="https://agdamsbo.github.io/project.aid/" class="external-link"><code>project.aid</code></a> package, which is moving towards CRAN submission. Install dev-version with <code>pak::pak("agdamsbo/project.aid")</code>.</p>
|
||
<div class="section level4">
|
||
<h4 id="functions-24-10-1">Functions:<a class="anchor" aria-label="anchor" href="#functions-24-10-1"></a></h4>
|
||
<ul><li><p>UPDATE: <code><a href="../reference/pase_calc.html">pase_calc()</a></code> updated for uniform column naming in output as well as streamlining the function a bit.</p></li>
|
||
<li><p>Moving: The following functions are moved to <code>agdamsbo/project.aid</code> to focus on (stroke) trial related functions: <code><a href="../reference/str_extract.html">str_extract()</a></code>, <code><a href="../reference/add_padding.html">add_padding()</a></code>, <code><a href="../reference/age_calc.html">age_calc()</a></code>, <code><a href="../reference/chunks_of_n.html">chunks_of_n()</a></code>, <code><a href="../reference/contrast_text.html">contrast_text()</a></code>, <code><a href="../reference/files_filter.html">files_filter()</a></code>, <code><a href="../reference/quantile_cut.html">quantile_cut()</a></code>, <code><a href="../reference/write_ical.html">write_ical()</a></code>.</p></li>
|
||
<li><p>NEW: <code>mfi_calc()</code> calculates domain scores from the MFI questionnaire. Takes data frame of 20 ordered as the questionnaire. Default is to reverse questions with reverse scoring.</p></li>
|
||
</ul><p>Checks set up with <code>rhub</code> v2</p>
|
||
</div>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 class="pkg-version" data-toc-text="23.9.1" id="stroke-2391">stRoke 23.9.1<a class="anchor" aria-label="anchor" href="#stroke-2391"></a></h2><p class="text-muted">CRAN release: 2023-09-07</p>
|
||
<div class="section level4">
|
||
<h4 id="functions-23-9-1">Functions:<a class="anchor" aria-label="anchor" href="#functions-23-9-1"></a></h4>
|
||
<ul><li><p>NEW: <code><a href="../reference/chunks_of_n.html">chunks_of_n()</a></code> uses <code><a href="https://rdrr.io/r/base/split.html" class="external-link">split()</a></code> to separate supplied vector or data frame into chunks of n. Flags to set if all but the last chunks should be exactly size n, or if they should be evenly sized of max n. Labels can be provided including regex pattern for subject naming to include in chunk names.</p></li>
|
||
<li><p>NEW: <code><a href="../reference/n_chunks.html">n_chunks()</a></code> is the opposite of <code><a href="../reference/chunks_of_n.html">chunks_of_n()</a></code> and is simply a wrapper for this function to create list of n chunks based of provided vector or data frame.</p></li>
|
||
<li><p>NEW: <code><a href="../reference/str_extract.html">str_extract()</a></code> will extract the substring of a character string given by a regex pattern. Came to be as a helper function for labelling chunks in <code><a href="../reference/chunks_of_n.html">chunks_of_n()</a></code>, but will be useful on its own. Other functions doing the same exists, but this is my take only using base <em>R</em>. Draws on <code>REDCapCAST::strsplitx()</code>, where splits can be performed around a pattern.</p></li>
|
||
<li><p>NEW: <code><a href="../reference/add_padding.html">add_padding()</a></code> was created out of frustration. I wanted to add padding using <code>sprintf("%0s",string)</code>, in examples for the above, but it would fail when rendering on Windows. Say hello to another function. Just very small. Defaults to adding leading zeros, to get all string to equal length with the longer string supplied.</p></li>
|
||
<li><p>Deprecation: <code><a href="../reference/ds2dd.html">ds2dd()</a></code> moved to <code>REDCapCAST::ds2dd()</code> as this is where it belongs.</p></li>
|
||
</ul></div>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 class="pkg-version" data-toc-text="23.6.3" id="stroke-2363">stRoke 23.6.3<a class="anchor" aria-label="anchor" href="#stroke-2363"></a></h2><p class="text-muted">CRAN release: 2023-07-03</p>
|
||
<div class="section level4">
|
||
<h4 id="bug-23-6-3">Bug<a class="anchor" aria-label="anchor" href="#bug-23-6-3"></a></h4>
|
||
<ul><li>Fixed <code><a href="../reference/ds2dd.html">ds2dd()</a></code> bug after first practical implementation.</li>
|
||
</ul></div>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 class="pkg-version" data-toc-text="23.6.2" id="stroke-2362">stRoke 23.6.2<a class="anchor" aria-label="anchor" href="#stroke-2362"></a></h2>
|
||
<div class="section level4">
|
||
<h4 id="functions-23-6-2">Functions:<a class="anchor" aria-label="anchor" href="#functions-23-6-2"></a></h4>
|
||
<ul><li>NEW: <code><a href="../reference/pase_calc.html">pase_calc()</a></code> function calculates PASE scores from raw questionnaire data. Gives sub scores as well and returns basic data quality and completeness checks. Acknowledges the difference between the scoring manual and the article by Washburn PA. et al. (1999) on including sitting work in the score calculations.</li>
|
||
</ul></div>
|
||
<div class="section level4">
|
||
<h4 id="data-23-6-2">Data:<a class="anchor" aria-label="anchor" href="#data-23-6-2"></a></h4>
|
||
<ul><li>NEW: <code>pase</code> sample questionnaire data. Non-identifiable and for use with the <code><a href="../reference/pase_calc.html">pase_calc()</a></code> function.</li>
|
||
</ul></div>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 class="pkg-version" data-toc-text="23.6.1" id="stroke-2361">stRoke 23.6.1<a class="anchor" aria-label="anchor" href="#stroke-2361"></a></h2>
|
||
<div class="section level4">
|
||
<h4 id="functions-23-6-1">Functions:<a class="anchor" aria-label="anchor" href="#functions-23-6-1"></a></h4>
|
||
<ul><li>NEW: ‘color_plot()’ function implements the ‘contrast_text()’ and is very much inspired from ‘scales::show_col()’. Passes arguments to the internal ‘contrast_text()’. Tests and all. Took way longer than intended.</li>
|
||
</ul></div>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 class="pkg-version" data-toc-text="23.4.1" id="stroke-2341">stRoke 23.4.1<a class="anchor" aria-label="anchor" href="#stroke-2341"></a></h2><p class="text-muted">CRAN release: 2023-04-13</p>
|
||
<div class="section level4">
|
||
<h4 id="functions-23-4-1">Functions:<a class="anchor" aria-label="anchor" href="#functions-23-4-1"></a></h4>
|
||
<ul><li>NEW: ds2dd() creates a REDCap data dictionary based on a data set for easy upload. A new vignette will be provided for example use. A separate vignette has been added.</li>
|
||
</ul></div>
|
||
<div class="section level4">
|
||
<h4 id="notes-23-4-1">Notes:<a class="anchor" aria-label="anchor" href="#notes-23-4-1"></a></h4>
|
||
<ul><li>With newer additions to the package, these functions clearly has their potential use also outside stroke research.</li>
|
||
<li>A new vector with REDCap metadata headers has been added. Can be called with data(metadata_names).</li>
|
||
</ul></div>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 class="pkg-version" data-toc-text="23.1.8" id="stroke-2318">stRoke 23.1.8<a class="anchor" aria-label="anchor" href="#stroke-2318"></a></h2>
|
||
<div class="section level4">
|
||
<h4 id="functions-23-1-8">Functions:<a class="anchor" aria-label="anchor" href="#functions-23-1-8"></a></h4>
|
||
<ul><li>write_ical() is an easy to use implementation of the package <code><a href="https://github.com/atfutures/calendar" class="external-link">library(calendar)</a></code> for easy conversion of spreadsheets to ical object. Export an .ics file using <code><a href="https://atfutures.github.io/calendar/reference/ic_write.html" class="external-link">calendar::ic_write()</a></code>.</li>
|
||
<li>contrast_text() calculates the best contrast text color for a given background color. For use in graphics.</li>
|
||
</ul></div>
|
||
<div class="section level4">
|
||
<h4 id="notes-23-1-8">Notes:<a class="anchor" aria-label="anchor" href="#notes-23-1-8"></a></h4>
|
||
<ul><li>This is the first update on CRAN.</li>
|
||
</ul></div>
|
||
<div class="section level4">
|
||
<h4 id="documentation-23-1-8">Documentation<a class="anchor" aria-label="anchor" href="#documentation-23-1-8"></a></h4>
|
||
<ul><li>Badges, lots of badges</li>
|
||
</ul></div>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 class="pkg-version" data-toc-text="23.1.7" id="stroke-2317">stRoke 23.1.7<a class="anchor" aria-label="anchor" href="#stroke-2317"></a></h2><p class="text-muted">CRAN release: 2023-01-24</p>
|
||
<div class="section level4">
|
||
<h4 id="notes-23-1-7">Notes:<a class="anchor" aria-label="anchor" href="#notes-23-1-7"></a></h4>
|
||
<ul><li>This is the version first published on CRAN as of 24.jan.2023.</li>
|
||
<li>This is also the version first published to zenodo.org, and with corresponding <a href="https://doi.org/10.5281/zenodo.7572023" class="external-link">doi: 10.5281/zenodo.7572023</a>.</li>
|
||
</ul></div>
|
||
<div class="section level4">
|
||
<h4 id="functions-23-1-7">Functions:<a class="anchor" aria-label="anchor" href="#functions-23-1-7"></a></h4>
|
||
<ul><li>redcap_read_tables() has been removed from the package for now. Looking to add it back later as a minimal data acquisition tool.</li>
|
||
</ul></div>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 class="pkg-version" data-toc-text="23.1.6" id="stroke-2316---failed-due-to-dependencies">stRoke 23.1.6 - failed due to dependencies<a class="anchor" aria-label="anchor" href="#stroke-2316---failed-due-to-dependencies"></a></h2>
|
||
<div class="section level4">
|
||
<h4 id="new-attempt-at-cran-submission-23-1-6">New attempt at CRAN submission<a class="anchor" aria-label="anchor" href="#new-attempt-at-cran-submission-23-1-6"></a></h4>
|
||
</div>
|
||
<div class="section level4">
|
||
<h4 id="functions-23-1-6">Functions:<a class="anchor" aria-label="anchor" href="#functions-23-1-6"></a></h4>
|
||
<ul><li>win_prop() added to implement the suggested methods in <a href="https://doi.org/10.1161/STROKEAHA.121.037744" class="external-link">DOI: 10.1161/STROKEAHA.121.037744</a>, as an implementation of “Tournament Methods” also found in <code><a href="https://rdrr.io/r/base/library.html" class="external-link">library(genodds)</a></code>. The function is based on the spreadsheet provided by the authors. A print.win_Prop is also added for printing.</li>
|
||
</ul></div>
|
||
<div class="section level4">
|
||
<h4 id="notes-23-1-6">Notes:<a class="anchor" aria-label="anchor" href="#notes-23-1-6"></a></h4>
|
||
<ul><li>23.1.5 failed on CRAN due to gt_plot(). This function has been dropped. Find it as as_ggplot() elsewhere.</li>
|
||
<li>agdamsbo/REDCapRITS added as “Additional_repositories”.</li>
|
||
<li>Included references listed as authors.</li>
|
||
</ul></div>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 class="pkg-version" data-toc-text="23.1.5" id="stroke-2315">stRoke 23.1.5<a class="anchor" aria-label="anchor" href="#stroke-2315"></a></h2>
|
||
<div class="section level4">
|
||
<h4 id="release-on-cran---failed-23-1-5">RELEASE ON CRAN - failed<a class="anchor" aria-label="anchor" href="#release-on-cran---failed-23-1-5"></a></h4>
|
||
</div>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 class="pkg-version" data-toc-text="0.23.1.4" id="stroke-02314">stRoke 0.23.1.4<a class="anchor" aria-label="anchor" href="#stroke-02314"></a></h2>
|
||
<div class="section level4">
|
||
<h4 id="functions-0-23-1-4">Functions:<a class="anchor" aria-label="anchor" href="#functions-0-23-1-4"></a></h4>
|
||
<ul><li>plot_olr() has been deprecated and removed.</li>
|
||
<li>ci_plot() functionality extended to include logistic model plotting.</li>
|
||
<li>age_calc() use vapply() instead of sapply()</li>
|
||
<li>gt_plot() function added to plot gt elements as ggplots. From <a href="https://github.com/MSKCC-Epi-Bio/bstfun" class="external-link">bstfun</a>. Not all done and satisfied with the layout with patchwork.</li>
|
||
</ul></div>
|
||
<div class="section level4">
|
||
<h4 id="documentation-0-23-1-4">Documentation<a class="anchor" aria-label="anchor" href="#documentation-0-23-1-4"></a></h4>
|
||
<ul><li>Trying to complete all flags from goodpractice and inteRgrate</li>
|
||
</ul></div>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 class="pkg-version" data-toc-text="0.23.1.3" id="stroke-02313">stRoke 0.23.1.3<a class="anchor" aria-label="anchor" href="#stroke-02313"></a></h2>
|
||
<div class="section level4">
|
||
<h4 id="functions-0-23-1-3">Functions:<a class="anchor" aria-label="anchor" href="#functions-0-23-1-3"></a></h4>
|
||
<ul><li>files_filter() added. Simple function to get file names in path with specified filter.</li>
|
||
<li>updated cpr_dob to give warnings if format is not recognised and return NAs.</li>
|
||
<li>ci_plot() updated to actually handle binary factors. Uses glm(), not lm().</li>
|
||
</ul></div>
|
||
<div class="section level4">
|
||
<h4 id="documentation-0-23-1-3">Documentation:<a class="anchor" aria-label="anchor" href="#documentation-0-23-1-3"></a></h4>
|
||
<ul><li>test, test and tests to satisfy codecov and, of course, ensure higher quality</li>
|
||
<li>changes to comply with goodpractices::gp()</li>
|
||
</ul><p>…and probably some more.</p>
|
||
</div>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 class="pkg-version" data-toc-text="0.23.1.2" id="stroke-02312">stRoke 0.23.1.2<a class="anchor" aria-label="anchor" href="#stroke-02312"></a></h2>
|
||
<div class="section level4">
|
||
<h4 id="functions-0-23-1-2">Functions:<a class="anchor" aria-label="anchor" href="#functions-0-23-1-2"></a></h4>
|
||
<ul><li>cpr_dob() now includes <code>format=</code>.</li>
|
||
<li>Other minor updates.</li>
|
||
</ul></div>
|
||
<div class="section level4">
|
||
<h4 id="documentation-0-23-1-2">Documentation:<a class="anchor" aria-label="anchor" href="#documentation-0-23-1-2"></a></h4>
|
||
<ul><li>Two new vignettes</li>
|
||
<li>Taking last steps in documenting before releasing on CRAN</li>
|
||
</ul></div>
|
||
<div class="section level4">
|
||
<h4 id="other-0-23-1-2">Other:<a class="anchor" aria-label="anchor" href="#other-0-23-1-2"></a></h4>
|
||
<ul><li>New hex logo</li>
|
||
</ul></div>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 class="pkg-version" data-toc-text="0.23.1.1" id="stroke-02311">stRoke 0.23.1.1<a class="anchor" aria-label="anchor" href="#stroke-02311"></a></h2>
|
||
<div class="section level4">
|
||
<h4 id="functions-0-23-1-1">Functions:<a class="anchor" aria-label="anchor" href="#functions-0-23-1-1"></a></h4>
|
||
<ul><li>age_calc() now also outputs a numeric vector for units=“days”, and not a character vector as difftime() would.</li>
|
||
</ul></div>
|
||
<div class="section level4">
|
||
<h4 id="documentation-0-23-1-1">Documentation:<a class="anchor" aria-label="anchor" href="#documentation-0-23-1-1"></a></h4>
|
||
<ul><li>Added a <code>NEWS.md</code> file to track changes to the package.</li>
|
||
<li>Added codecov</li>
|
||
<li>Added tests with the help of gpttools</li>
|
||
</ul></div>
|
||
</div>
|
||
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
|
||
</nav></aside></div>
|
||
|
||
|
||
<footer><div class="pkgdown-footer-left">
|
||
<p>Developed by Andreas Gammelgaard Damsbo.</p>
|
||
</div>
|
||
|
||
<div class="pkgdown-footer-right">
|
||
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p>
|
||
</div>
|
||
|
||
</footer></div>
|
||
|
||
|
||
|
||
|
||
|
||
</body></html>
|
||
|