Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/neuropsychology/Psycho.jl

The Julia Toolbox for Psychological Science
https://github.com/neuropsychology/Psycho.jl

Last synced: 16 days ago
JSON representation

The Julia Toolbox for Psychological Science

Awesome Lists containing this project

README

        

psycho logo julia package

*

The Julia Toolbox for Psychological Science*

# Psycho.jl
[![Build Status](https://travis-ci.org/neuropsychology/Psycho.jl.svg?branch=master)](https://travis-ci.org/neuropsychology/Psycho.jl)
[![Build status](https://ci.appveyor.com/api/projects/status/313hx3rmmc1swckg?svg=true)](https://ci.appveyor.com/project/DominiqueMakowski/psycho-jl)
[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://neuropsychology.github.io/Psycho.jl/latest/)
[![codecov](https://codecov.io/gh/neuropsychology/Psycho.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/neuropsychology/Psycho.jl)
[![HitCount](http://hits.dwyl.io/neuropsychology/neuropsychology/psycho.jl.svg)](http://hits.dwyl.io/neuropsychology/neuropsychology/psycho.jl)

# Goal

***"From Julia to Manuscript"***

`Psycho`'s primary goal is to fill the gap between Julia's output and the formatted result description of your manuscript, with the automated use of **best practices** guidelines, ensuring standardization and quality of results reporting.
It also provides useful tools and functions for psychologists, neuropsychologists and neuroscientists for their everyday data analyses.

# Contribute

`Psycho.jl` **is a young package in need of affection**. You can easily hop aboard the [developpment](.github/CONTRIBUTING.md) of this open-source software and improve psychological science by doing the following:

- Create or check existing issues to report, replicate, understand or solve some bugs.
- Create or check existing issues to suggest or discuss a new feature.
- Check existing issues to see things that we'd like to implement, but where help is needed to do it.
- Check existing issues to give your opinion and participate in package's design discussions.

Don't be shy, try to code and submit a pull request (See the [contributing guide](.github/CONTRIBUTING.md)). Even if unperfect, we will help you make it great! All contributors will be very graciously rewarded someday :smirk:.

# Installation

```
pkg> add https://github.com/neuropsychology/Psycho.jl.git
```

# Documentation

- Reports: Interpret and report your models
- Effect Sizes: Rules of thumb and interprettation
- Signal Detection Theory: SDT's related indices

# Examples

## Report all the things

### Data

```julia
using Psycho

# Simulate some data
data = simulate_data_correlation([[0.3], [0.1]])

# Standardize the results
standardize!(data)

# Describe the data
report(data)
```
```
The data contains 200 observations of the following variables:
- y (Mean = 0 ± 1.0 [-2.92, 3.07])
- Var1 (Mean = 0 ± 1.0 [-2.35, 3.25])
- Group (1FD, 50.0%; 2HA, 50.0%)
```

### Linear Models (GLM)

```julia
using GLM

# Fit a Linear Model
model = lm(@formula(y ~ Var1 * Group), data)

# Report the results
results = report(model)
```
```
We fitted a linear regression to predict y with Var1 and Group (Formula: y ~ 1 + Var1 + Group + Var1 & Group).
The model's explanatory power (R²) is of 0.05 (adj. R² = 0.04). The model's intercept is at 0.0. Within this model:
- Var1 is significant (Coef = 0.3, t(196) = 3.05, 95% CI [0.11; 0.49], p < .01) and can be considered as small (Std. Coef = 0.3).
- Group: 2HA is not significant (Coef = 0, t(196) = 0, 95% CI [-0.27; 0.27], p > .1) and can be considered as very small (Std. Coef = 0).
- Var1 & Group: 2HA is not significant (Coef = -0.2, t(196) = -1.44, 95% CI [-0.47; 0.07], p > .1) and can be considered as very small (Std. Coef = -0.2).
```

## Signal Detection Theory (SDT)

```julia
sdt_indices(hit=6, fa=7, miss=8, cr=9)
```
```
Dict{String,Float64} with 10 entries:
"hit_rate" => 0.428571
"fa_rate" => 0.4375
"dprime" => -0.0235319
"beta" => 0.995497
"c" => 0.191778
"c_relative" => -8.14973
"Xc" => 0.180012
"aprime" => 0.490992
"bpp" => 0.263158
"pr" => -0.00892857
"br" => 0.433628
"dprime_glm" => -0.0227017
"Xc_glm" => 0.157311
```