docs/index.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>Generate Synthetic SEND Data • SENDsanitizer</title>
<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.5.2/css/all.min.css" rel="stylesheet">
<link href="deps/font-awesome-6.5.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="Generate Synthetic SEND Data">
<meta name="description" content="An R package that generate synthetic SEND data based on real SEND data.">
<meta property="og:description" content="An R package that generate synthetic SEND data based on real SEND data.">
</head>
<body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-primary" data-bs-theme="dark" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="index.html">SENDsanitizer</a>

    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.0.0.9000</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/introduction.html">Introduction</a></li>
    <li><a class="dropdown-item" href="articles/ts_documentation.html">Trial Summary (TS) Domain</a></li>
    <li><a class="dropdown-item" href="articles/tx_documentation.html">Trial Sets (TX) Domain</a></li>
    <li><a class="dropdown-item" href="articles/dm_documentation.html">Demographics (DM) Domain</a></li>
    <li><a class="dropdown-item" href="articles/bw_documentation.html">Body Weight (BW) Domain</a></li>
    <li><a class="dropdown-item" href="articles/lb_documentation.html">Laboratory Test (LB) Domain</a></li>
    <li><a class="dropdown-item" href="articles/om_documentation.html">Organ Measurements (OM) Domain</a></li>
    <li><a class="dropdown-item" href="articles/mi_documentation.html">Microscopic Findings (MI) Domain</a></li>
    <li><a class="dropdown-item" href="articles/bayesian_regression_model.html">Bayesian Regression Model</a></li>
    <li><a class="dropdown-item" href="articles/mi_calculation.html">MI Synthetic Data Generation Steps</a></li>
  </ul>
</li>
      </ul>
<ul class="navbar-nav">
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/phuse-org/SENDsanitizer" aria-label="github"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul>
</div>


  </div>
</nav><div class="container template-home">
<div class="row">
  <main id="main" class="col-md-9"><div class="section level1">
<div class="page-header"><h1 id="sendsanitizer">SENDsanitizer<a class="anchor" aria-label="anchor" href="#sendsanitizer"></a>
</h1></div>
<p><strong>SENDsanitizer</strong> is an <strong>R</strong> <strong>package</strong> to generate synthetic data from real data.</p>
<div class="section level2">
<h2 id="overview">Overview<a class="anchor" aria-label="anchor" href="#overview"></a>
</h2>
<p>The Standard for Exchange of Nonclinical Data (<strong>SEND</strong>), developed by the Clinical Data Interchange Standards Consortium (CDISC), offers a <strong>structured</strong> <strong>electronic</strong> <strong>format</strong> to organize and exchange <strong>nonclinical</strong> study data among sponsor companies, contract research organizations (CROs), and health authorities.</p>
<p>SENDsanitizer is an R package designed to generate synthetic SEND-formatted data by modifying real SEND-formatted datasets. It anonymizes the data by replacing sensitive information like dates and other specific details with predefined text, ensuring that identities cannot be traced. Additionally, potentially identifiable data elements are removed entirely to maintain privacy. For numerical values, SENDsanitizer generates synthetic data using Bayesian regression model.</p>
</div>
<div class="section level2">
<h2 id="installation">Installation<a class="anchor" aria-label="anchor" href="#installation"></a>
</h2>
<p>Development version can be installed from GitHub.</p>
<pre><code><span><span class="co"># install devtools if already not installed</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/utils/install.packages.html" class="external-link">install.packages</a></span><span class="op">(</span><span class="st">"devtools"</span><span class="op">)</span></span>
<span></span>
<span><span class="co">#install toxSummary package</span></span>
<span><span class="fu">devtools</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">'phuse-org/SENDsanitizer'</span><span class="op">)</span></span></code></pre>
<div class="section level4">
<h4 id="to-generate-one-synthetic-study-dataset-from-one-real-study">To generate one synthetic study dataset from one real study<a class="anchor" aria-label="anchor" href="#to-generate-one-synthetic-study-dataset-from-one-real-study"></a>
</h4>
<pre><code><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://github.com/phuse-org/SENDsanitizer" class="external-link">SENDsanitizer</a></span><span class="op">)</span></span>
<span><span class="fu">SENDsanitizer</span><span class="fu">::</span><span class="fu"><a href="reference/sanitize.html">sanitize</a></span><span class="op">(</span>path<span class="op">=</span><span class="st">'path/to/directory/of/xpt/files/of/study/'</span>,</span>
<span>where_to_save<span class="op">=</span><span class="st">'path/to/directory/where/generated/files/should/be/saved/'</span><span class="op">)</span></span></code></pre>
</div>
<div class="section level4">
<h4 id="to-generate-one-synthetic-study-dataset-from-multiple-real-study">To generate one synthetic study dataset from multiple real study<a class="anchor" aria-label="anchor" href="#to-generate-one-synthetic-study-dataset-from-multiple-real-study"></a>
</h4>
<pre><code><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://github.com/phuse-org/SENDsanitizer" class="external-link">SENDsanitizer</a></span><span class="op">)</span></span>
<span><span class="va">study_01</span> <span class="op">&lt;-</span> <span class="st">'path/to/directory/of/xpt/files/of/study_01/'</span></span>
<span><span class="va">study_02</span> <span class="op">&lt;-</span> <span class="st">'path/to/directory/of/xpt/files/of/study_02/'</span></span>
<span><span class="va">multiple_studies</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="va">study_01</span>,<span class="va">study_02</span><span class="op">)</span></span>
<span><span class="fu">SENDsanitizer</span><span class="fu">::</span><span class="fu"><a href="reference/sanitize.html">sanitize</a></span><span class="op">(</span>path<span class="op">=</span> <span class="va">multiple_studies</span>,</span>
<span>where_to_save<span class="op">=</span><span class="st">'path/to/directory/where/generated/files/should/be/saved/'</span><span class="op">)</span></span></code></pre>
</div>
<div class="section level3">
<h3 id="install-from-cloned-repo">Install from cloned repo<a class="anchor" aria-label="anchor" href="#install-from-cloned-repo"></a>
</h3>
<p>Clone the <a href="https://github.com/phuse-org/SENDsanitizer" class="external-link">GitHub</a> repo and set repo as working directory.</p>
<pre><code><span><span class="fu">devtools</span><span class="fu">::</span><span class="fu"><a href="https://devtools.r-lib.org/reference/load_all.html" class="external-link">load_all</a></span><span class="op">(</span><span class="st">"."</span><span class="op">)</span></span>
<span><span class="fu">SENDsanitizer</span><span class="fu">::</span><span class="fu"><a href="reference/sanitize.html">sanitize</a></span><span class="op">(</span>path<span class="op">=</span><span class="st">'path/to/directory/of/xpt/files/of/study/'</span>,</span>
<span>where_to_save<span class="op">=</span><span class="st">'path/to/directory/where/generated/files/should/be/saved/'</span><span class="op">)</span></span></code></pre>
<p>Notes on Example SEND Studies:<br>
It is recommended to use multiple example studies for better results. These SEND format example studies must have similar arms/dosing regimens (with the option to include or exclude recovery animals), SEND Version, and have the same SSTYP and species. The script checks for these values to be similar and will provide errors based on which of these conditions is not met.</p>
</div>
</div>
</div>
  </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/phuse-org/SENDsanitizer/" class="external-link">Browse source code</a></li>
<li><a href="https://github.com/phuse-org/SENDsanitizer/issues" class="external-link">Report a bug</a></li>
</ul>
</div>

<div class="license">
<h2 data-toc-skip>License</h2>
<ul class="list-unstyled">
<li><a href="LICENSE.html">Full license</a></li>
<li><small><a href="https://opensource.org/licenses/mit-license.php" class="external-link">MIT</a> + file <a href="LICENSE-text.html">LICENSE</a></small></li>
</ul>
</div>


<div class="citation">
<h2 data-toc-skip>Citation</h2>
<ul class="list-unstyled">
<li><a href="authors.html#citation">Citing SENDsanitizer</a></li>
</ul>
</div>

<div class="developers">
<h2 data-toc-skip>Developers</h2>
<ul class="list-unstyled">
<li>Md Yousuf Ali <br><small class="roles"> Maintainer, author </small>  </li>
<li>Susan Butler <br><small class="roles"> Author </small>  </li>
<li>Kevin Snyder <br><small class="roles"> Author </small>  </li>
<li><a href="authors.html">More about authors...</a></li>
</ul>
</div>


  </aside>
</div>


    <footer><div class="pkgdown-footer-left">
  <p>Developed by Md Yousuf Ali, Susan Butler, Kevin Snyder.</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>