>Documentation Guidelines<a class="anchor" aria-label="anchor" href="#documentation-guidelines"></a>
</h5>
<p>All functions should be documented using roxygen2 with the following
sections:</p>
<ul>
<li>Title (first line)</li>
<li>Description (paragraph after title)</li>
<li>
<span class="citation">@param</span> for each parameter</li>
<li>
<span class="citation">@return</span> for the return value</li>
<li>
<span class="citation">@examples</span> for usage examples</li>
<li>
<span class="citation">@export</