Skip to content

neuropsychology/neuropsychology.R

Repository files navigation

neuropsychology

An R Toolbox for Psychologists, Neuropsychologists and Neuroscientists.

Name neuropsychology
Latest Version
Latest Version
Documentation Rdoc
Downloads
Authors

⚠️ NOTE: This package is not maintained anymore. Many of its functions have been moved to the psycho package


Installation

  • To get the stable version (0.5.0) From CRAN, run the following commands in your R console:
install.packages("neuropsychology")
library("neuropsychology")
  • To get the latest development version (0.5.1), run the following:
install.packages("devtools")
library("devtools")
install_github("neuropsychology/neuropsychology.R")
library("neuropsychology")

If it doesn't work, try updating R. If the problem persists, create an issue.


Feature Examples

Create a braincloud

A wordcloud containing the most reccurent words of one or several papers. First, create a folder with several PDFs (journal articles for example, but you can also use your own specific word list). Add an R script in it and run one of the following:

braincloud()
braincloud(image="brain1", text.size=0.6, colours.replicate=FALSE)

Note: these brainclouds are based on the work of Dr. Robin Carhart-Harris.

Compare a patient's score with the parent population

Your patient has an IQ of 78. What does it mean? You'd like to insert a plot in your report? Use the assess() function, that compares your patient's score with the mean and standard deviation of your test (for the IQ, 100 and 15, respectively).

assess(score=78, mean=100, sd=15)

You can also compare it to a custom parent distribution if you have the data. For example, your patient is 27 and you want to see where it stands compared to the participants of the `personality` dataset. You can also change the colours. See `?assess` for more documentation.
assess(score=27, distribution=personality$Age)
"The participant (score = 27) is positioned at 0.02 standard deviations from the mean (M = 26.8, SD = 10.59). 
The participant's score is greater than 74.42 % of the general population."

To save the plot:
plot <- assess(score=27, distribution=personality$Age)
ggsave("assess_plot.png", plot)

Get a correlation plot and table with significance stars

cortable(personality)

write.csv(cortable(personality), "mytable.csv") # Save the table
ggsave("corplot.png", cortable(personality)) # Save the plot

This function will automatically select the numeric columns of your dataframe and show a correlation table with significance stars. You can adjust the p value by applying different corrections or change the type of correlation type (Spearman's, Pearson's or partial correlations). You can also view the result in RStudio or save it as a .csv file to open it in excel. Run ?cortable for documentation.


Contribute

  • You need some help? You found a bug? You would like to request a new feature? Just open an issue ☺️
  • Want to add yourself a feature? Correct a bug? You're more than welcome to contribute! Check this tutorial (French or English) to see how to submit your changes on github.
  • Check this style guide to write R code with style.

Citation

Run the following commands to see the proper citation entry in APA6 or Bibtex format:

library("neuropsychology")
citation("neuropsychology")

Note: The authors do not give any warranty. If this software causes your keyboard to blow up, your brain to liquefy, your toilet to clog or a zombie plague to leak, the authors CANNOT IN ANY WAY be held responsible.