https://github.com/jefferis/igorr

R package to load Igor Pro waves (ibw) and experiment files (pxp) in R
https://github.com/jefferis/igorr

electrophysiology igor neuromatic pro r

Last synced: about 2 months ago
JSON representation

R package to load Igor Pro waves (ibw) and experiment files (pxp) in R

• Host: GitHub
• URL: https://github.com/jefferis/igorr
• Owner: jefferis
• Created: 2010-10-01T19:13:27.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2024-08-23T09:31:28.000Z (4 months ago)
• Last Synced: 2024-10-12T21:29:44.972Z (2 months ago)
• Topics: electrophysiology, igor, neuromatic, pro, r
• Language: R
• Homepage: http://jefferis.github.io/IgorR/
• Size: 1.41 MB
• Stars: 7
• Watchers: 3
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md

Awesome Lists containing this project

README

        
# IgorR

[![DOI](https://img.shields.io/badge/doi-10.5281%2Fzenodo.10230-blue.svg)](http://dx.doi.org/10.5281/zenodo.10230) 

[![Release Version](https://img.shields.io/github/release/jefferis/IgorR.svg)](https://github.com/jefferis/IgorR/releases/latest) 

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/IgorR)](https://cran.r-project.org/package=IgorR)

[![R-CMD-check](https://github.com/jefferis/IgorR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jefferis/IgorR/actions/workflows/R-CMD-check.yaml)

  

Introduction

============

The IgorR package for R provides routines to read binary files generated by [Igor Pro](https://www.wavemetrics.com).

This includes both the standalone .ibw Igor Binary Wave format (v2 and the latest v5) and the .pxp Packed Experiment Format including both waves and variables.  In addition the package provides functions to read files generated by the [Neuromatic](http://www.neuromatic.thinkrandom.com) analysis suite written by Jason Rothman for Igor Pro.

Installation

============

Standard Install

----------------

NB IgorR is off CRAN due to an unfixed bug with windows text on tecent versions of R. Whenever it is back there you can install the release version from [CRAN](https://cran.r-project.org/)

```r

install.packages('IgorR')

```

Github Install

--------------

To install the latest development version from github

```r

# install remotes package if required

if(!require('remotes')) install.packages('remotes')

remotes::install_github('jefferis/IgorR')

```

Development Install

-------------------

To checkout a version that can be used for development 

([RStudio](https://posit.co/products/open-source/rstudio/) is strongly recommended), 

in your terminal application.

```sh

cd /some/suitable/dir

git clone https://github.com/jefferis/IgorR.git

```

In R

```r

install.packages('devtools') # install hadley's devtools

library(devtools)

load_all('/some/suitable/dir/IgorR')

test()

#hack

load_all()

# ready for release

check()

build_win() # test for Windows

release()

```

Details

=======

Details of the ibw file format were derived from the [Igor Technical Note 003](https://www.wavemetrics.net/Downloads/FTP_Archive/IgorPro/Technical_Notes/TN003.zip). 

For those interested in the source code, `ReadIgorBinary.R` provides code for standard pxp and ibw files, while `ReadNclamp.R` provides routines to read packed experiment files generated by the Nclamp data acquisition package.