_pkgdown.yml

url: https://mhealthgroup.github.io/MIMSunit
destination: docs/
reference:
  - title: "Top-level API for MIMS-unit algorithm"
    desc: >
      Function to compute MIMS-unit value and estimate sensor orientation.
    contents:
      - mims_unit_from_files
      - mims_unit
      - sensor_orientations
      - custom_mims_unit
      - shiny_app
  - title: "File IO"
    desc: >
      Functions for importing or exporting data for various data formats.
    contents:
      - starts_with("import")
      - starts_with("export")
  - title: "Datasets"
    desc: >
      Processed datasets that store the results in the manuscript and supplementary material.
    contents:
      - cv_different_algorithms
      - measurements_different_devices
      - sample_raw_accel_data
      - conceptual_diagram_data
      - rest_on_table
      - edge_case
  - title: "Signal Filtering"
    desc: "Functions to filter multi-channel accelerometer signal."
    contents:
      - iir
      - bandlimited_interp
  - title: "Signal transformation"
    desc: "Functions to transform the multi-channel accelerometer signal."
    contents:
      - compute_orientation
      - sum_up
      - vector_magnitude
  - title: "Signal extrapolation"
    desc: "Functions to extrapolate multi-channel accelerometer signal."
    contents:
      - extrapolate
      - extrapolate_rate
  - title: "Signal aggregation"
    desc: "Functions to aggregate over epochs of multi-channel accelerometer signal."
    contents:
      - aggregate_for_mims
      - aggregate_for_orientation
  - title: "Util functions"
    desc: >
      Utility functions.
    contents:
      - sampling_rate
      - parse_epoch_string
      - cut_off_signal
      - interpolate_signal
      - simulate_new_data
      - clip_data
      - segment_data
  - title: "Visualization helper functions"
    desc: >
      Functions to help visualizing signals, intermediate results and MIMS-unit results.
    contents:
      - illustrate_signal
      - illustrate_extrapolation
      - generate_interactive_plot

development:
  mode: auto
  destination: /

authors:
  Qu Tang:
    href: https://qutang.dev
    html: <img class='img-circle p-3' src="https://d33wubrfki0l68.cloudfront.net/8af2089476f179254b3bc9628e13f7d143acab42/8309e/images/avatar.jpg" height="40" /><span> Qu Tang</span>
  Dinesh John:
    href: "https://bouve.northeastern.edu/directory/dinesh-john/"
    html: <img class='img-circle p-3' src="https://banner2.kisspng.com/20180410/bbw/kisspng-avatar-user-medicine-surgery-patient-avatar-5acc9f7a7cb983.0104600115233596105109.jpg" height="40" /><span> Dinesh John</span>
  Stephen Intille:
    href: "http://www.ccs.neu.edu/home/intille/"
    html: <img class='img-circle p-3' src="http://www.ccs.neu.edu/home/intille/intille-headshot-sm2.jpg" height="40" /><span> Stephen Intille</span>
  mHealth Research Group:
    href: "https://mhealthgroup.org"
    html: <img src="https://www.mhealthgroup.org/uploads/1/1/1/1/111147333/unnamed.gif" height="24" />

template:
  bootstrap: 3
  params:
    ganalytics: UA-38342303-3
navbar:
  title: "MIMSunit"
  left:
    - text: "Get Started"
      menu:
        - text: "Compute MIMS-unit from files"
          href: articles/mims_unit_from_files.html
        - text: "Compute MIMS-unit from imported data"
          href: articles/mims_unit_from_imported_data.html
    - text: "Datasets"
      href: articles/datasets.html
    - text: "Algorithm Walkthrough"
      menu:
        - text: "Step-by-step illustration"
          href: articles/conceptual_diagram.html
        - text: "Deciding truncation threshold"
          href: articles/truncation_threshold.html
    - text: "Performances"
      menu:
        - text: "Cross device consistency"
          href: articles/cross_device_consistency.html
        - text: "Performance under edge conditions"
          href: articles/edge_cases.html
    - text: "API References"
      href: "reference/index.html"
    - text: "Changelogs"
      href: "news/index.html"
    - text: "FAQs"
      href: "articles/faq.html"
  right:
    - icon: fa-lg fa-github
      href: https://github.com/mhealthgroup/mimsunit