Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/stewid/rmatio

An R package to read and write matlab files
https://github.com/stewid/rmatio

Last synced: 10 days ago
JSON representation

An R package to read and write matlab files

Host: GitHub
URL: https://github.com/stewid/rmatio
Owner: stewid
License: gpl-3.0
Created: 2013-04-21T19:19:10.000Z (over 11 years ago)
Default Branch: main
Last Pushed: 2023-12-13T20:04:59.000Z (11 months ago)
Last Synced: 2024-06-11T18:16:38.732Z (5 months ago)
Language: C
Homepage:
Size: 1.85 MB
Stars: 10
Watchers: 4
Forks: 4
Open Issues: 9
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Build Status](https://github.com/stewid/rmatio/actions/workflows/R-CI.yaml/badge.svg)](https://github.com/stewid/rmatio/actions/workflows/R-CI.yaml)

[![CRAN status](http://www.r-pkg.org/badges/version/rmatio)](http://cran.r-project.org/web/packages/rmatio/index.html)

[![CRAN RStudio mirror downloads](http://cranlogs.r-pkg.org/badges/last-month/rmatio)](http://cran.r-project.org/web/packages/rmatio/index.html)

[![Code coverage](https://codecov.io/gh/stewid/rmatio/branch/configure/graph/badge.svg)](https://app.codecov.io/gh/stewid/rmatio)

rmatio

======

`rmatio` is a package for reading and writing Matlab MAT files from

R. `rmatio` supports reading MAT version 4, MAT version 5 and MAT

compressed version 5. `rmatio` can write version 5 MAT files and

version 5 files with variable compression.

Internally, the `rmatio` package uses the C library

[matio](http://sourceforge.net/projects/matio/) for reading/writing

MATLAB MAT files.

You can track (and contribute to) development of `rmatio`

at https://github.com/stewid/rmatio.

Installation

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

To install the latest release on CRAN

```

install.packages('rmatio')

```

To install the development version of rmatio, it's easiest to use the

`remotes` package:

```

# install.packages("remotes")

library(remotes)

install_github("stewid/rmatio")

```

Usage

-----

```

library(rmatio)

```

Read a compressed version 5 MAT file from an URL

```

url <- "https://raw.githubusercontent.com/stewid/rmatio/master/inst/extdata/matio_test_cases_compressed_le.mat"

m <- read.mat(url)

```

View content

```

str(m)

```

Write an uncompressed version 5 MAT file

```

write.mat(m, filename="test-uncompressed.mat", compression=FALSE, version="MAT5")

```

Write a compressed version 5 MAT file

```

write.mat(m, filename="test-compressed.mat", compression=TRUE, version="MAT5")

```

Check that the content of the files are identical

```

identical(read.mat("test-uncompressed.mat"), read.mat("test-compressed.mat"))

```

Read a version 4 MAT file with little-endian byte ordering

```

filename <- system.file('extdata/matio_test_cases_v4_le.mat', package='rmatio')

m <- read.mat(filename)

```

View content

```

str(m)

```

Read a version 4 MAT file with big-endian byte ordering

```

filename <- system.file('extdata/matio_test_cases_v4_be.mat', package='rmatio')

m <- read.mat(filename)

```

View content

```

str(m)

```

Included software

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

- The C library [matio](http://sourceforge.net/projects/matio/) (http://sourceforge.net/projects/matio/)

License

-------

The `rmatio` package is licensed under the GPLv3. See these files for

additional details:

- LICENSE     - `rmatio` package license (GPLv3)

- inst/NOTICE - Copyright notices for additional included software