a b/docs/CONTRIBUTING.html 

  1
  
<!-- Generated by pkgdown: do not edit by hand -->





  
  

  2
  
<!DOCTYPE html>





  
  

  3
  
<html lang="en">





  
  

  4
  
  <head>





  
  

  5
  
  <meta charset="utf-8">





  
  

  6
  
<meta http-equiv="X-UA-Compatible" content="IE=edge">





  
  

  7
  
<meta name="viewport" content="width=device-width, initial-scale=1.0">





  
  

  8
  





  
  

  9
  
<title>Contributing to biotmle development • biotmle</title>





  
  

  10
  





  
  

  11
  





  
  

  12
  
<!-- jquery -->





  
  

  13
  
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>





  
  

  14
  
<!-- Bootstrap -->





  
  

  15
  
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/readable/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />





  
  

  16
  





  
  

  17
  





  
  

  18
  
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script>





  
  

  19
  





  
  

  20
  
<!-- bootstrap-toc -->





  
  

  21
  
<link rel="stylesheet" href="bootstrap-toc.css">





  
  

  22
  
<script src="bootstrap-toc.js"></script>





  
  

  23
  





  
  

  24
  
<!-- Font Awesome icons -->





  
  

  25
  
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" />





  
  

  26
  
<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" />





  
  

  27
  





  
  

  28
  
<!-- clipboard.js -->





  
  

  29
  
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>





  
  

  30
  





  
  

  31
  
<!-- headroom.js -->





  
  

  32
  
<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>





  
  

  33
  
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>





  
  

  34
  





  
  

  35
  
<!-- pkgdown -->





  
  

  36
  
<link href="pkgdown.css" rel="stylesheet">





  
  

  37
  
<script src="pkgdown.js"></script>





  
  

  38
  





  
  

  39
  





  
  

  40
  





  
  

  41
  





  
  

  42
  
<meta property="og:title" content="Contributing to biotmle development" />





  
  

  43
  





  
  

  44
  





  
  

  45
  





  
  

  46
  





  
  

  47
  
<!-- mathjax -->





  
  

  48
  
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>





  
  

  49
  
<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>





  
  

  50
  





  
  

  51
  
<!--[if lt IE 9]>





  
  

  52
  
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>





  
  

  53
  
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>





  
  

  54
  
<![endif]-->





  
  

  55
  





  
  

  56
  





  
  

  57
  





  
  

  58
  
  </head>





  
  

  59
  





  
  

  60
  
  <body data-spy="scroll" data-target="#toc">





  
  

  61
  
    <div class="container template-title-body">





  
  

  62
  
      <header>





  
  

  63
  
      <div class="navbar navbar-default navbar-fixed-top" role="navigation">





  
  

  64
  
  <div class="container">





  
  

  65
  
    <div class="navbar-header">





  
  

  66
  
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">





  
  

  67
  
        <span class="sr-only">Toggle navigation</span>





  
  

  68
  
        <span class="icon-bar"></span>





  
  

  69
  
        <span class="icon-bar"></span>





  
  

  70
  
        <span class="icon-bar"></span>





  
  

  71
  
      </button>





  
  

  72
  
      <span class="navbar-brand">





  
  

  73
  
        <a class="navbar-link" href="index.html">biotmle</a>





  
  

  74
  
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.17.0</span>





  
  

  75
  
      </span>





  
  

  76
  
    </div>





  
  

  77
  





  
  

  78
  
    <div id="navbar" class="navbar-collapse collapse">





  
  

  79
  
      <ul class="nav navbar-nav">





  
  

  80
  
        <li>





  
  

  81
  
  <a href="index.html">





  
  

  82
  
    <span class="fas fa-home fa-lg"></span>





  
  

  83
  
     





  
  

  84
  
  </a>





  
  

  85
  
</li>





  
  

  86
  
<li>





  
  

  87
  
  <a href="reference/index.html">Reference</a>





  
  

  88
  
</li>





  
  

  89
  
<li class="dropdown">





  
  

  90
  
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">





  
  

  91
  
    Articles





  
  

  92
  
     





  
  

  93
  
    <span class="caret"></span>





  
  

  94
  
  </a>





  
  

  95
  
  <ul class="dropdown-menu" role="menu">





  
  

  96
  
    <li>





  
  

  97
  
      <a href="articles/exposureBiomarkers.html">Identifying Biomarkers from an Exposure Variable with `biotmle`</a>





  
  

  98
  
    </li>





  
  

  99
  
  </ul>





  
  

  100
  
</li>





  
  

  101
  
      </ul>





  
  

  102
  
      <ul class="nav navbar-nav navbar-right">





  
  

  103
  
        <li>





  
  

  104
  
  <a href="https://github.com/nhejazi/biotmle/">





  
  

  105
  
    <span class="fab fa-github fa-lg"></span>





  
  

  106
  
     





  
  

  107
  
  </a>





  
  

  108
  
</li>





  
  

  109
  
      </ul>





  
  

  110
  
      





  
  

  111
  
    </div><!--/.nav-collapse -->





  
  

  112
  
  </div><!--/.container -->





  
  

  113
  
</div><!--/.navbar -->





  
  

  114
  





  
  

  115
  
      





  
  

  116
  





  
  

  117
  
      </header>





  
  

  118
  





  
  

  119
  
<div class="row">





  
  

  120
  
  <div class="contents col-md-9">





  
  

  121
  
    <div class="page-header">





  
  

  122
  
      <h1>Contributing to biotmle development</h1>





  
  

  123
  
    </div>





  
  

  124
  





  
  

  125
  
<div id="contributing-to-biotmle-development" class="section level1">





  
  

  126
  





  
  

  127
  
<p>We, the authors of the <code>biotmle</code> R package, use the same guide as is used for contributing to the development of the popular <code>tidyverse</code> ecosystem of R packages. This document is simply a formal re-statement of that fact.</p>





  
  

  128
  
<p>The goal of this guide is to help you get up and contributing to <code>biotmle</code> as quickly as possible. The guide is divided into two main pieces:</p>





  
  

  129
  
<ul>





  
  

  130
  
<li>Filing a bug report or feature request in an issue.</li>





  
  

  131
  
<li>Suggesting a change via a pull request.</li>





  
  

  132
  
</ul>





  
  

  133
  
<div id="issues" class="section level2">





  
  

  134
  
<h2 class="hasAnchor">





  
  

  135
  
<a href="#issues" class="anchor"></a>Issues</h2>





  
  

  136
  
<p>When filing an issue, the most important thing is to include a minimal reproducible example so that we can quickly verify the problem, and then figure out how to fix it. There are three things you need to include to make your example reproducible: required packages, data, code.</p>





  
  

  137
  
<ol>





  
  

  138
  
<li><p><strong>Packages</strong> should be loaded at the top of the script, so it’s easy to see which ones the example needs.</p></li>





  
  

  139
  
<li><p>The easiest way to include <strong>data</strong> is to use <code><a href="https://rdrr.io/r/base/dput.html">dput()</a></code> to generate the R code to recreate it.</p></li>





  
  

  140
  
<li>





  
  

  141
  
<p>Spend a little bit of time ensuring that your <strong>code</strong> is easy for others to read:</p>





  
  

  142
  
<ul>





  
  

  143
  
<li><p>make sure you’ve used spaces and your variable names are concise, but informative</p></li>





  
  

  144
  
<li><p>use comments to indicate where your problem lies</p></li>





  
  

  145
  
<li><p>do your best to remove everything that is not related to the problem. The shorter your code is, the easier it is to understand.</p></li>





  
  

  146
  
</ul>





  
  

  147
  
</li>





  
  

  148
  
</ol>





  
  

  149
  
<p>You can check you have actually made a reproducible example by starting up a fresh R session and pasting your script in.</p>





  
  

  150
  
<p>(Unless you’ve been specifically asked for it, please don’t include the output of <code><a href="https://rdrr.io/r/utils/sessionInfo.html">sessionInfo()</a></code>.)</p>





  
  

  151
  
</div>





  
  

  152
  
<div id="pull-requests" class="section level2">





  
  

  153
  
<h2 class="hasAnchor">





  
  

  154
  
<a href="#pull-requests" class="anchor"></a>Pull requests</h2>





  
  

  155
  
<p>To contribute a change to <code>biotmle</code>, you follow these steps:</p>





  
  

  156
  
<ol>





  
  

  157
  
<li>Create a branch in git and make your changes.</li>





  
  

  158
  
<li>Push branch to GitHub and issue pull request (PR).</li>





  
  

  159
  
<li>Discuss the pull request.</li>





  
  

  160
  
<li>Iterate until either we accept the PR or decide that it’s not a good fit for <code>biotmle</code>.</li>





  
  

  161
  
</ol>





  
  

  162
  
<p>Each of these steps are described in more detail below. This might feel overwhelming the first time you get set up, but it gets easier with practice.</p>





  
  

  163
  
<p>If you’re not familiar with git or GitHub, please start by reading <a href="http://r-pkgs.had.co.nz/git.html" class="uri">http://r-pkgs.had.co.nz/git.html</a></p>





  
  

  164
  
<p>Pull requests will be evaluated against a checklist:</p>





  
  

  165
  
<ol>





  
  

  166
  
<li>





  
  

  167
  
<strong>Motivation</strong>. Your pull request should clearly and concisely motivates the need for change. Please describe the problem your PR addresses and show how your pull request solves it as concisely as possible.</li>





  
  

  168
  
</ol>





  
  

  169
  
<p>Also include this motivation in <code>NEWS</code> so that when a new release of <code>biotmle</code> comes out it’s easy for users to see what’s changed. Add your item at the top of the file and use markdown for formatting. The news item should end with <code>(@yourGithubUsername, #the_issue_number)</code>.</p>





  
  

  170
  
<ol>





  
  

  171
  
<li>





  
  

  172
  
<p><strong>Only related changes</strong>. Before you submit your pull request, please check to make sure that you haven’t accidentally included any unrelated changes. These make it harder to see exactly what’s changed, and to evaluate any unexpected side effects.</p>





  
  

  173
  
<p>Each PR corresponds to a git branch, so if you expect to submit multiple changes make sure to create multiple branches. If you have multiple changes that depend on each other, start with the first one and don’t submit any others until the first one has been processed.</p>





  
  

  174
  
</li>





  
  

  175
  
<li><p><strong>Use <code>biotmle</code> coding style</strong>. To do so, please follow the <a href="http://style.tidyverse.org">official <code>tidyverse</code> style guide</a>. Maintaining a consistent style across the whole code base makes it much easier to jump into the code. If you’re modifying existing <code>biotmle</code> code that doesn’t follow the style guide, a separate pull request to fix the style would be greatly appreciated.</p></li>





  
  

  176
  
<li><p>If you’re adding new parameters or a new function, you’ll also need to document them with <a href="https://github.com/klutometis/roxygen"><code>roxygen2</code></a>. Make sure to re-run <code><a href="https://devtools.r-lib.org//reference/document.html">devtools::document()</a></code> on the code before submitting.</p></li>





  
  

  177
  
</ol>





  
  

  178
  
<p>This seems like a lot of work but don’t worry if your pull request isn’t perfect. It’s a learning process. A pull request is a process, and unless you’ve submitted a few in the past it’s unlikely that your pull request will be accepted as is. Please don’t submit pull requests that change existing behaviour. Instead, think about how you can add a new feature in a minimally invasive way.</p>





  
  

  179
  
</div>





  
  

  180
  
</div>





  
  

  181
  





  
  

  182
  
  </div>





  
  

  183
  





  
  

  184
  
  <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">





  
  

  185
  
    <nav id="toc" data-toggle="toc" class="sticky-top">





  
  

  186
  
      <h2 data-toc-skip>Contents</h2>





  
  

  187
  
    </nav>





  
  

  188
  
  </div>





  
  

  189
  





  
  

  190
  
</div>





  
  

  191
  





  
  

  192
  





  
  

  193
  





  
  

  194
  
      <footer>





  
  

  195
  
      <div class="copyright">





  
  

  196
  
  <p>Developed by Nima Hejazi, Alan Hubbard, Mark van der Laan.</p>





  
  

  197
  
</div>





  
  

  198
  





  
  

  199
  
<div class="pkgdown">





  
  

  200
  
  <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>





  
  

  201
  
</div>





  
  

  202
  





  
  

  203
  
      </footer>





  
  

  204
  
   </div>





  
  

  205
  





  
  

  206
  
  





  
  

  207
  





  
  

  208
  





  
  

  209
  
  </body>





  
  

  210
  
</html>





  
  

  211
  





  
  

  212