nsrr / chat-documentation

CHAT documentation for sleepdata.org
0 stars 0 forks source link

General comment about abbreviation for seconds and possible word change CHAT pages HRV Analysis Overview Sub-analyses #66

Closed JLArnold closed 6 years ago

JLArnold commented 8 years ago

https://www.sleepdata.org/datasets/chat/pages/hrv-analysis.md

General Comment: we are still trying to come to a consensus for the unit seconds to be spelled out vs an abbreviation. This example has seconds spelled out, and abbreviations sec and s. Unit for minutes is spelled out and has abbreviation min in this example as well. This a global issue throughout the CHAT documentation and I assume throughout documentation for other studies as well. CHAT HRV Analysis Overview, Sub-analyses, item 2 abbreviation “s” is used for seconds, seconds is spelled out in item 1, should it be spelled out in item 2 as well? Minute is also spelled out in this section except for time 2, “5-min” could be “5-minute”. “<2.5 s, only 5-min windows” could be “<2.5 seconds, only 5-minute windows”. This is also referred to a “5-minute segments” on this page. Should “windows” be “segments”?

image