update to version v0.3.0 [skip ci]

DESCRIPTION

@@ -1,9 +1,11 @@
 Package: eegUtils
 Type: Package
 Title: A collection of utilities for EEG analysis 
-Version: 0.2.1.9000
-Date: 2018-08-18
-Authors@R: person("Matt", "Craddock", role = c("aut", "cre"), email = "matt@mattcraddock.com")
+Version: 0.3.0
+Date: 2018-11-22
+Authors@R: c(
+  person("Matt", "Craddock", role = c("aut", "cre"), email = "matt@mattcraddock.com"),
+  person("Matti", "Vuorre", role = "ctb", email = "mv2521@columbia.edu"))
 Maintainer: Matt Craddock <matt@mattcraddock.com>
 Description: A collection of functions for basic EEG processing. Includes import
   functions for Biosemi (BDF) and Neuroscan (CNT), topographical plotting, referencing, and epoching.

NEWS.md

@@ -1,22 +1,24 @@
-# eegUtils 0.2.1.9000
+# eegUtils 0.3.0
 
 
 ### Function changes
-- `topoplot()` now has a scaling parameter to scale the size of any lines or markers drawn on the plot
-- `plot_tfr()` function now useable, with baseline correction added.
+- `topoplot()` now has a scaling parameter to scale the size of any lines or markers drawn on the plot.
+- `plot_tfr()` function now useable, with baseline correction also added.
 - `rm_baseline()` now handles `eeg_tfr` objects.
 - `as.data.frame()` method added for `eeg_tfr` objects.
 - `compute_tfr()` function now available for use with Morlet wavelets.
-- `plot_psd()` now allows changing of FFT parameters (e.g. number off FFT points, segment length)
+- `plot_psd()` now allows changing of FFT parameters (e.g. number of FFT points, segment length)
 - Data selectors added for `eeg_tfr` objects (e.g. `select_elecs()`)
 
 ### Internal changes/ bug fixes
-- `plot_timecourse()` overhauled to be S3 method
+- `plot_timecourse()` overhauled to be S3 method.
 - `plot_butterfly()` reworked internally to be more efficient
 - `rm_baseline()` simplified internally, reworked to use matrices; split to separate file.
 - `select_elecs()` now works for `eeg_evoked` objects
 - `eeg_decomp` function in progress for performing SSD analyses
 - Various methods added for TFR analyses
+- `topoplot()` improvements internally. Now offers potential for facetting.
+- Some `dplyr` functions implemented internally for some objects.
 
 # eegUtils 0.2.1
 

README.md

@@ -1,8 +1,8 @@
-# eegUtils 0.2.1.9000
+# eegUtils 0.3.0
 
 <a href="http://www.repostatus.org/#wip"><img src="http://www.repostatus.org/badges/latest/wip.svg" alt="Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public." /></a> [![Coverage Status](https://img.shields.io/codecov/c/github/craddm/eegUtils/master.svg)](https://codecov.io/github/craddm/eegUtils?branch=master) [![Build Status](https://travis-ci.org/craddm/eegUtils.svg?branch=master)](https://travis-ci.org/craddm/eegUtils) [![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/craddm/eegUtils?branch=master&svg=true)](https://ci.appveyor.com/project/craddm/eegUtils) [![DOI](https://zenodo.org/badge/85406871.svg)](https://zenodo.org/badge/latestdoi/85406871)
 
-Some helper utilities for plotting and processing EEG data in R. The package is in the early stages of development, and may be subject to a lot of changes.
+Some utilities for plotting and processing of EEG data in R. The package is in the early stages of development, and may be subject to a lot of changes.
 
 Use devtools::install_github('craddm/eegUtils') to install it.
 
@@ -18,12 +18,16 @@ An introduction to its use can be found at the *eegUtils* website [https://cradd
 * `interp_elecs()` - spherical spline interpolation of EEG channels
 * `eeg_downsample()` - filter and downsample data to a lower sampling rate.
 * `eeg_FASTER()` - automatic artefact rejection algorithm for epoched data
+* `run_ICA()` - decompose your data using an ICA algorithm such as SOBI or Infomax
 
 ## Plotting functions 
 * `topoplot()` - plotting of topographies 
 * `plot_timecourse()`/`plot_butterfly()` - plotting individual timecourses from electrodes or plotting all electrodes at once
 * `erp_scalp()` - plotting ERP plots for individual electrodes in a topographical layout - thanks to Matti Vuorre!
 * `interactive_scalp()` - a Shiny version of erp_scalp() that allows you to zoom in on specific electrodes.
-* `browse_data()` - a Shiny gadget for interactively scrolling through EEG data (continous or epoched)
+* `browse_data()` - a Shiny gadget for interactively scrolling through EEG data (continous or epoched).
+* `erp_raster()` - plot an ERP raster, showin the ERP for every channel as a single image.
+* `erp_image()` - plot an ERP image from a single electrode.
+* `plot_psd()` - plot the Power Spectral Density of an `eeg_data` or `eeg_epochs` object.
 
 `as.data.frame()` methods exist for `eeg_data` and `eeg_epochs` objects, so you can convert your data to a data frame for use with whatever analysis method you like.