Deployed 7020734 with MkDocs version: 1.5.2

index.html

@@ -90,6 +90,8 @@
                 <h1 id="welcome-to-the-tsdf-time-series-data-format-python-package">Welcome to the TSDF (Time Series Data Format) Python package</h1>
 <p>A package to work with TSDF data in Python. This implementation is based on the the TSDF format specification, which can be found in this <a href="https://arxiv.org/abs/2211.11294">preprint</a>.</p>
 <h2 id="what-is-tsdf-data">What is TSDF data?</h2>
+<p><code>tsdf</code> stands for <em><code>time series data format</code></em>.
+It is a unified, standardized format for storing all types of physiological sensor data. It was originally introduced in this <a href="https://arxiv.org/abs/2211.11294">preprint</a>.</p>
 <p>TSDF provides a unified, user-friendly format for both numerical sensor data and metadata, utilizing raw binary data and JSON-format text files for measurements/timestamps and metadata, respectively. It defines essential metadata fields to enhance data interpretability and exchangeability, aiming to bolster scientific reproducibility in studies reliant on digital biosensor data as a critical evidence base across various disease domains.</p>
 <h2 id="example-tsdf-metadata">Example: TSDF Metadata</h2>
 <p>This example demonstrates a TSDF metadata JSON file, showcasing the structured format used to easily interpret and read the corresponding binary data. For more intricate examples and detailed specifications, the paper serves as a comprehensive reference.</p>
@@ -216,5 +218,5 @@ <h2 id="the-python-library-tsdf">The python library - <code>tsdf</code></h2>
 
 <!--
 MkDocs version : 1.5.2
-Build Date UTC : 2023-09-18 07:29:21.309067+00:00
+Build Date UTC : 2023-09-22 10:49:07.297067+00:00
 -->

installation/index.html

@@ -46,6 +46,8 @@
               <ul class="current">
                 <li class="toctree-l1 current"><a class="reference internal current" href="./">Installation</a>
     <ul class="current">
+    <li class="toctree-l2"><a class="reference internal" href="#installing-tsdf">Installing tsdf</a>
+    </li>
     <li class="toctree-l2"><a class="reference internal" href="#installing-the-development-version">Installing the development version</a>
     </li>
     <li class="toctree-l2"><a class="reference internal" href="#what-now">What now?</a>
@@ -86,6 +88,7 @@
             <div class="section" itemprop="articleBody">
 
                 <h1 id="installation">Installation</h1>
+<h2 id="installing-tsdf">Installing tsdf</h2>
 <p>The package is available in <a href="https://pypi.org/project/tsdf/">PyPI</a>. The latest stable release can be installed using:</p>
 <pre><code class="language-bash">pip install tsdf
 </code></pre>

processing_example/index.html

@@ -1285,7 +1285,7 @@ <h3 id="load-dummy-data">Load dummy data<a class="anchor-link" href="#load-dummy
 <span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata_dict</span><span class="p">[</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">data_name</span><span class="si">}</span><span class="s2">.bin&quot;</span><span class="p">]</span>
 
 <span class="c1"># Load the data</span>
-<span class="n">data</span> <span class="o">=</span> <span class="n">metadata</span><span class="o">.</span><span class="n">load_binary</span><span class="p">()</span>
+<span class="n">data</span> <span class="o">=</span> <span class="n">tsdf</span><span class="o">.</span><span class="n">load_binary_from_metadata</span><span class="p">(</span><span class="n">metadata</span><span class="p">)</span>
 
 <span class="c1"># Print some info</span>
 <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Data type used for storing:</span><span class="se">\t</span><span class="s2"> </span><span class="si">{</span><span class="n">data</span><span class="o">.</span><span class="n">dtype</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
@@ -1303,7 +1303,7 @@ <h3 id="load-dummy-data">Load dummy data<a class="anchor-link" href="#load-dummy
 metadata = metadata_dict[f"{data_name}.bin"]
 
 # Load the data
-data = metadata.load_binary()
+data = tsdf.load_binary_from_metadata(metadata)
 
 # Print some info
 print(f"Data type used for storing:\t {data.dtype}")

sitemap.xml

@@ -2,27 +2,27 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://biomarkersparkinson.github.io/tsdf/</loc>
-         <lastmod>2023-09-18</lastmod>
+         <lastmod>2023-09-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://biomarkersparkinson.github.io/tsdf/contact/</loc>
-         <lastmod>2023-09-18</lastmod>
+         <lastmod>2023-09-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://biomarkersparkinson.github.io/tsdf/installation/</loc>
-         <lastmod>2023-09-18</lastmod>
+         <lastmod>2023-09-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://biomarkersparkinson.github.io/tsdf/processing_example/</loc>
-         <lastmod>2023-09-18</lastmod>
+         <lastmod>2023-09-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://biomarkersparkinson.github.io/tsdf/tsdf_fields_table/</loc>
-         <lastmod>2023-09-18</lastmod>
+         <lastmod>2023-09-22</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>

tsdf_fields_table/index.html

@@ -44,7 +44,7 @@
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#tsdf-mandatory-fields">TSDF mandatory fields</a>
     </li>
-    <li class="toctree-l2"><a class="reference internal" href="#tsdf-domain-specific-fields">TSDF domain-specific fields</a>
+    <li class="toctree-l2"><a class="reference internal" href="#tsdf-optional-fields">TSDF optional fields</a>
     </li>
     <li class="toctree-l2"><a class="reference internal" href="#legacy-fields">Legacy fields</a>
     </li>
@@ -181,7 +181,7 @@ <h2 id="tsdf-mandatory-fields">TSDF mandatory fields</h2>
 </tr>
 </tbody>
 </table>
-<h2 id="tsdf-domain-specific-fields">TSDF domain-specific fields</h2>
+<h2 id="tsdf-optional-fields">TSDF optional fields</h2>
 <table>
 <thead>
 <tr>