Skip to content

Commit

Permalink
revise readme.rmd
Browse files Browse the repository at this point in the history
fix typos; add description and links
  • Loading branch information
Kathleen Wendt committed May 27, 2019
1 parent 5cb351d commit 481d056
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 13 deletions.
13 changes: 8 additions & 5 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,30 +18,33 @@ knitr::opts_chunk$set(
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
<!-- badges: end -->

The `psyphr` R package turns [psychophysilology](https://en.wikipedia.org/wiki/Psychophysiology) lab data from proprietary equipments into a [tidy](http://vita.had.co.nz/papers/tidy-data.pdf) form, wherever approapriate, for downstream analysis.
The `psyphr` R package turns [psychophysiological](https://en.wikipedia.org/wiki/Psychophysiology) data from
proprietary data collection and processing systems into a [tidy](http://vita.had.co.nz/papers/tidy-data.pdf) form for downstream analysis
and visualization.

The package is currently under active development. Currently, only [EDA](https://support.mindwaretech.com/manuals/software/eda/3-2/) and [HRV](https://support.mindwaretech.com/manuals/software/hrv/3-2/) data from MindWare is supported.
The package is currently under active development. Currently, only [Electrodermal Activity](https://support.mindwaretech.com/manuals/software/eda/3-2/) and [Heart Rate Variability](https://support.mindwaretech.com/manuals/software/hrv/3-2/) output data from [MindWare Technologies](https://www.mindwaretech.com/) are supported.


## TODO

The development team considers the following for the package's future:

- Submit `psyphr` to [rOpenSci](https://ropensci.org/) for peer review and publication
- Customizable data QA utilities, with meaningful defaults
- Common visualization schemes
- Study compilation utility
- Compatibility on data feeds from more vendors' equipments
- Compatibility on data feeds from other popular data collection and processing systems (e.g., [BIOPAC](https://www.biopac.com/))


## Installation

You can install the released version of psyphr from [CRAN](https://CRAN.R-project.org) with:
Install the released version of `psyphr` from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("psyphr")
```

And the development version from [GitHub](https://github.com/) with:
Install the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
Expand Down
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,18 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h
<!-- badges: end -->

The `psyphr` R package turns
[psychophysilology](https://en.wikipedia.org/wiki/Psychophysiology) lab
data from proprietary equipments into a
[tidy](http://vita.had.co.nz/papers/tidy-data.pdf) form, wherever
approapriate, for downstream analysis.
[psychophysiological](https://en.wikipedia.org/wiki/Psychophysiology)
data from proprietary data collection and processing systems into a
[tidy](http://vita.had.co.nz/papers/tidy-data.pdf) form for downstream
analysis and visualization.

The package is currently under active development. Currently, only
[EDA](https://support.mindwaretech.com/manuals/software/eda/3-2/) and
[HRV](https://support.mindwaretech.com/manuals/software/hrv/3-2/) data
from MindWare is supported.
[Electrodermal
Activity](https://support.mindwaretech.com/manuals/software/eda/3-2/)
and [Heart Rate
Variability](https://support.mindwaretech.com/manuals/software/hrv/3-2/)
output data from [MindWare Technologies](https://www.mindwaretech.com/)
are supported.

## TODO

Expand All @@ -27,7 +30,8 @@ The development team considers the following for the package’s future:
- Customizable data QA utilities, with meaningful defaults
- Common visualization schemes
- Study compilation utility
- Compatibility on data feeds from more vendors’ equipments
- Compatibility on data feeds from other popular data collection and
processing systems (e.g., [BIOPAC](https://www.biopac.com/))

## Installation

Expand Down

5 comments on commit 481d056

@iqis
Copy link
Contributor

@iqis iqis commented on 481d056 May 27, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, Wendy!

@wendtke
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not my nickname

@iqis
Copy link
Contributor

@iqis iqis commented on 481d056 May 27, 2019 via email

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wendtke
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooo, I'm leaving for San Francisco in the morning. Then, we will be officially working coast-to-coast.

@iqis
Copy link
Contributor

@iqis iqis commented on 481d056 May 27, 2019 via email

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.