Package 'matlab2r'

Description

Prints package version number and welcome message on package load

Usage

.onAttach(libname, pkgname)

Arguments

Description

Throw error if condition false

Usage

assert(cond, msg = "Assertion failed.", A = NULL)

Arguments

Value

The error message if cond == FALSE, nothing otherwise

Author(s)

Waldir Leoncio

Examples

minVal <- 7
x <- 26
assert(minVal < x) # should return nothing
maxVal <- 13
## Not run: 
  assert((minVal < x) && (x < maxVal))
  assert(x == "a", "x is %s", class(x))

## End(Not run)

Description

Create character vector of blanks

Usage

blanks(n)

Arguments

Details

This function emulates the behavior of a homonimous function from Matlab

Value

Vector of n blanks

Author(s)

Waldir Leoncio

Examples

blanks(1)
blanks(3)

Description

Creates an array of zeros

Usage

cell(n, sz = c(n, n), expandable = FALSE, ...)

Arguments

Value

An array of zeroes with the dimensions passed on call

Examples

cell(5)
cell(5, 2)

Description

A character array is a sequence of characters, just as a numeric array is a sequence of numbers. A typical use is to store a short piece of text as a row of characters in a character vector.

Usage

char(A)

## S4 method for signature 'character'
char(A)

## S4 method for signature 'array'
char(A)

Arguments

Value

A converted to characters

Methods (by class)

• char(character): Converting a character vector

• char(array): Converting a character array

Author(s)

Waldir Leoncio

Examples

char("Hi!")
char(matrix(letters, 2))

Description

Simulates the function colon() and its equivalent : operator from Matlab, which have a similar but not quite equivalent behavior when compared to seq() and : in R.

Usage

colon(a, b)

Arguments

Value

A vector containing a sequence of integers going from a to b

Examples

colon(1, 4)
colon(4, 8)

Description

disp(X) displays the value of variable X without printing the variable name. This is a wrapper around base::cat() that includes a breakline in the end.

Usage

disp(X)

Arguments

Value

The value of X

Author(s)

Waldir Leoncio

Examples

A <- c(15, 150)
S <- 'Hello World.'
disp(A)
disp(S)

Description

Emulates behavior of find

Usage

find(x, sort = TRUE)

Arguments

Value

A vector of indices of x that satisfy the logical test (nonzero, by default).

Examples

X <- matrix(c(1, 0, 2, 0, 1, 1, 0, 0, 4), 3, byrow = TRUE)
Y <- seq(1, 19, 2)
find(X)
find(Y == 13)

Description

Rounds each element of input to the nearest integer towards zero. Basically the same as trunc()

Usage

fix(X)

Arguments

Value

The values of trunc(X).

Author(s)

Waldir Leoncio

Examples

X <- matrix(c(-1.9, -3.4, 1.6, 2.5, -4.5, 4.5), 3, byrow = TRUE)
Y <- matrix(c(-1, -3, 1, 2, -4, 4), 3, byrow = TRUE)
fix(X)
fix(Y)

Description

Calculates the natural logarithm of the gamma function

Usage

gammaln(A)

Arguments

Value

An element-by-element ln(gamma())-transformed A

Note

For MATLAB output reproduction, non-positive values will be

Author(s)

Waldir Leoncio

Examples

gammaln(8)
gammaln(0)
gammaln(matrix(1:9, 3))
gammaln(-4:10)

Description

Replicates the functionality of the homonymous function in Matlab (sans dialog box)

Usage

inputdlg(prompt, dims = 1, definput = NULL)

Arguments

Value

A user prompt

Examples

## Not run: 
 name <- inputdlg("Type your name")
 paste("Hello,", name)

## End(Not run)

Description

Determine whether array is empty. An empty array, table, or timetable has at least one dimension with length 0, such as 0-by-0 or 0-by-5.

Usage

isempty(x)

Arguments

Details

Emulates the behavior of the isempty function on Matlab

Value

A logical value determining if x is empty

Examples

isempty(array(dim = c(0, 2, 2)))
isempty(matrix(rep(NA, 4), 2))
isempty(matrix(rep(0, 4), 2))
isempty(as.factor(c(NA, NA)))
isempty(factor())
isempty(matrix(rep("", 3)))

Description

This function tries to replicate the behavior of the isfield function in Matlab

Usage

isfield(x, field)

Arguments

Value

A logical vector determining if field is within names(x)

References

https://se.mathworks.com/help/matlab/ref/isfield.html

Examples

S <- list(
  x = rnorm(100),
  title = "x"
)
isfield(S, "title")
isfield(S, "z")

Description

A simple check if an input corresponds to a valid path to a file

Usage

isFilePath(x)

Arguments

Value

TRUE if x is a valid path, FALSE otherwise

Author(s)

Waldir Leoncio

Description

Checks which members of one entity are in another

Usage

ismember(A, B, rows = FALSE, indices = FALSE)

## S4 method for signature 'data.frame,data.frame'
ismember(A, B, rows = FALSE, indices = FALSE)

Arguments

Value

a binary vector telling if the corresponding A indices are in B. If indices = TRUE, also prints the index in B where the match first occurs.

Author(s)

Waldir Leoncio

Examples

# Values that are members of set
A <- c(5, 3, 4, 2)
B <- c(2, 4, 4, 4, 6, 8)
ismember(A, B)

# Members of set and indices to values
ismember(A, B, indices = TRUE)

# Table rows found in another table
A <- data.frame(
 "V1" = 1:5, "V2" = LETTERS[1:5], "V3" = as.logical(c(0, 1, 0, 1, 0))
)
B <- data.frame(
 "V1" = seq(1, 9, 2), "V2" = LETTERS[seq(1, 9, 2)], "V3" = as.logical(rep(0, 5))
)
ismember(A, B)

Description

Does the

Usage

ismembertol(A, B, rows = FALSE, indices = TRUE)

Arguments

Value

Same as ismember

Author(s)

Waldir Leoncio

See Also

ismember

Examples

x <- t(1:6) * pi
y <- 10 ^ log10(x)

# Show that values are equal, but not identical (due to floating-point error)
all.equal(x, y)
identical(x, y)

# Checking the difference in outputs
ismember(x, y)
ismembertol(x, y)

Description

Determine which characters are space characters

Usage

isspace(A)

Arguments

Value

a vector TF such that the elements of TF are logical 1 (true) where corresponding characters in A are space characters, and logical 0 (false) elsewhere.

Note

Recognized whitespace characters are ⁠ ⁠ and ⁠\\t⁠.

Author(s)

Waldir Leoncio

Examples

chr <- "123 Main St."
X <- "\t a b\tcde f"
isspace(chr)
isspace(X)

Description

This is a soft wrap around the base::seq() function.

Usage

linspace(x1, x2, n = 100L)

Arguments

Value

A numeric vector of n numbers between x1 and x2.

Author(s)

Waldir Leoncio

Examples

linspace(-5, 4)
linspace(1 + 2i, 9 + 9i, 5)

Description

Base 2 logarithm and floating-point number dissection

Usage

log2(X, dissect = TRUE)

Arguments

Value

either a vector or a list of mantissas and exponents such that mantissa * 2 ^ exponent equals X

Examples

log2(10, dissect = FALSE)
log2(10)
.625 * 2 ^ 4 == 10  # proof

Description

Performs basic syntax conversion from a Matlab function file to R

Usage

matlab2r(
  input,
  output = "diff",
  improve_formatting = TRUE,
  change_assignment = TRUE,
  append = FALSE,
  restyle = !improve_formatting,
  skip_lines = NULL
)

Arguments

Value

text converted to R, printed to screen or replacing input file

Note

This function is intended to expedite the process of converting a Matlab function to R by making common replacements. It does not have the immediate goal of outputting a ready-to-use function. In other words, after using this function you should go back to it and make minor changes.

It is also advised to do a dry-run with output = "clean" and only switching to output = "save" when you are confident that no important code will be lost (for shorter functions, a careful visual inspection should suffice).

Author(s)

Waldir Leoncio

Examples

matlab_script <- system.file("extdata", "matlabDemo.m", package = "matlab2r")
matlab2r(matlab_script)
matlab2r(matlab_script, output = "clean")

Description

Finds the minimum value for each column of a matrix, potentially returning the indices instead

Usage

max(X, indices = TRUE)

Arguments

Value

Either a list or a vector

Author(s)

Waldir Leoncio

Examples

A <- matrix(c(23, 42, 37, 15, 52))
max(A)
base::max(A) # for comparison

Description

Finds the minimum value for each column of a matrix, potentially returning the indices instead

Usage

min(X, indices = TRUE)

Arguments

Value

Either a list or a vector

Author(s)

Waldir Leoncio

Examples

A <- matrix(c(23, 42, 37, 15, 52))
min(A)
base::min(A) # for comparison

Description

Returns the number of arguments passed to the parent function

Usage

nargin()

Value

An integer indicating how many input arguments a function received.

Note

This function only makes sense inside another function

Author(s)

Waldir Leoncio

References

https://stackoverflow.com/q/64422780/1169233

Examples

f <- function(x, y, z) return(nargin())
f(pi)
f(y = 6, z = 5)
f(letters)
f(letters, LETTERS, pi)

Description

Converts a numeric value to character. This is essentially a wrapper over base::as.character().

Usage

num2str(A, format)

## S4 method for signature 'numeric,missing'
num2str(A)

## S4 method for signature 'array,missing'
num2str(A)

## S4 method for signature 'numeric,numeric'
num2str(A, format)

## S4 method for signature 'array,numeric'
num2str(A, format)

## S4 method for signature 'numeric,character'
num2str(A, format)

## S4 method for signature 'array,character'
num2str(A, format)

Arguments

Value

A, with its format possibly reshaped by format

Methods (by class)

• num2str(A = numeric, format = missing): Converting a vector to character

• num2str(A = array, format = missing): Converting an array to character

• num2str(A = numeric, format = numeric): Rounding a vector, then converting to character

• num2str(A = array, format = numeric): Rounding an arrray, then converting to character

• num2str(A = numeric, format = character): Formatting a vector, then converting to character

• num2str(A = array, format = character): Formatting an array, then converting to character

Author(s)

Waldir Leoncio

Examples

X <- rnorm(10)
num2str(X)
num2str(X, 2)
A <- matrix(runif(4), 2)
num2str(A)
num2str(A, 3)
num2str(pi * 10, "%e")

Description

wrapper of zeros_or_ones() that replicates the behavior of the ones() function on Matlab

Usage

ones(n1, n2 = n1, ...)

Arguments

Value

An n1-by-n2 matrix of ones

Examples

ones(3)
ones(8, 1)

Description

This function aims to loosely mimic the behavior of the questdlg function on Matlab

Usage

questdlg(
  quest,
  dlgtitle = "",
  btn = c("y", "n"),
  defbtn = "n",
  accepted_ans = c("y", "yes", "n", "no")
)

Arguments

Value

Whatever is entered by the user after the prompt created by the function.

Examples

## Not run: 
  ans <- questdlg("Do you want to continue?", "Continue?")
  if (tolower(substring(ans, 1, 1)) == "y") {
    message("You typed yes")
  } else {
    message("You didn't type yes")
  }

## End(Not run)

Description

Imitates the behavior of rand() on Matlab

Usage

rand(r = 1, c = 1)

Arguments

Value

$r \times c$ matrix with random trials from a standard uniform distribution.

Examples

rand()
rand(3, 2)

Description

Rreturns the remainder after division of a by b, where a is the dividend and b is the divisor. This function is often called the remainder operation. The rem function follows the convention that rem(a,0) is NaN.

Usage

rem(a, b)

Arguments

Value

The remainder

Author(s)

Waldir Leoncio

Examples

rem(23, 5)
rem(1:5, 3)
rem(c(-4, -1, 7, 9), 3)  #FIXME
rem(c(0, 3.5, 5.9, 6.2, 9, 4 * pi), 2 * pi)

Description

Repeats a matrix over n columns and rows

Usage

repmat(mx, n)

Arguments

Details

This function was created to replicate the behavior of a homonymous function on Matlab

Value

matrix replicated over ncol(mx) * n columns and nrow(mx) * n rows

Note

The Matlab implementation of this function accepts n with length > 2.

It should also be noted that a concatenated vector in R, e.g. c(5, 2), becomes a column vector when coerced to matrix, even though it may look like a row vector at first glance. This is important to keep in mind when considering the expected output of this function. Vectors in R make sense to be seen as column vectors, given R's Statistics-oriented paradigm where variables are usually disposed as columns in a dataset.

Examples

x <- matrix(1:4, 2)
repmat(x, 1)
repmat(x, 2)
repmat(x, c(2, 3))

Description

Reshapes a matrix according to a certain number of dimensions

Usage

reshape(A, sz)

Arguments

Details

This function replicates the functionality of the reshape() function on Matlab. This function is basically a fancy wrapper for the array() function in R, but is useful because it saves the user translation time. Moreover, it introduces validation code that alter the behavior of array() and makes it more similar to replicate().

Value

the input matrix, reshaped according to the vector sz

Note

The Matlab function also accepts as input the dismemberment of sz as scalars.

Examples

mx <- matrix(1:4, 2)
ra <- array(1:12, c(2, 3, 2))

mx
reshape(mx, c(1, 4))

ra
reshape(ra, c(3, 2, 2))

Description

Loosely replicates the behavior of the homonym Matlab function

Usage

setdiff(A, B, legacy = FALSE)

Arguments

Value

An array containing he elements which are in A but not in B

Author(s)

Waldir Leoncio

Examples

A <- c(3, 6, 2, 1, 5, 1, 1)
B <- c(2, 4, 6)
setdiff(A, B)

Description

This functions tries to replicate the behavior of the base function "size" in Matlab

Usage

size(x, d)

Arguments

Value

A vector whose size is the number of dimensions of x and whose scale corresponds to the number of elements on (i.e. the size of) each dimension.

Note

On MATLAB, size(1, 100) returns 1. As a matter of fact, if the user calls for a dimension which x doesn't have size() always returns 1. R's default behavior is more reasonable in those cases (i.e., returning NA), but since the point of this function is to replicate MATLAB behaviors (bugs and questionable behaviors included), this function also does this.

Examples

size(10)
size(1:4)
size(matrix(1:6, 2))
size(array(1:24, c(2, 3, 4)))

Description

Emulates the behavior of the sortrows function on Matlab

Usage

sortrows(A, column = 1)

Arguments

Value

The A matrix sorted by the first row, then the second

Examples

mx <- matrix(c(3, 2, 2, 1, 1, 10, 0, pi), 4)
mx
sortrows(mx)

Description

Remove dimensions of length 1

Usage

squeeze(A)

Arguments

Details

This function implements the behavior of the homonimous function on Matlab. B = squeeze(A) returns an array with the same elements as the input array A, but with dimensions of length 1 removed. For example, if A is a 3-by-1-by-1-by-2 array, then squeeze(A) returns a 3-by-2 matrix. If A is a row vector, column vector, scalar, or an array with no dimensions of length 1, then squeeze returns the input A.

Value

An array with the same elements as the input array, but with dimensions of length 1 removed.

Note

This is basically a wrapper of drop() with a minor adjustment to adapt the output to what happens on Matlab

Author(s)

Waldir Leoncio

Examples

A <- array(dim = c(2, 1, 2))
A[, , 1] <- c(1, 2)
A[, , 2] <- c(3, 4)
print(A)
squeeze(A)

Description

Logical test if two character elements are identical

Usage

strcmp(s1, s2)

Arguments

Value

a logical element of the same type as the input

Examples

strcmp("yes", "no")
strcmp("yes", "yes")
strcmp("no", "no")

Description

Returns the sum of the elements of the first input

Usage

sum_MATLAB(A, dim)

## S4 method for signature 'array,missing'
sum_MATLAB(A)

## S4 method for signature 'array,character'
sum_MATLAB(A, dim)

## S4 method for signature 'array,numeric'
sum_MATLAB(A, dim)

Arguments

Value

The total, row or column sum of A

Methods (by class)

• sum_MATLAB(A = array, dim = missing): Sum elements of A along the first array dimension whose size does not equal 1

• sum_MATLAB(A = array, dim = character): Computes the sum of all elements of A

• sum_MATLAB(A = array, dim = numeric): Computes the sum of all elements of A

Author(s)

Waldir Leoncio

Examples

x1 <- array(1:9, c(3, 3))
sum_MATLAB(x1)
sum_MATLAB(x1, "all")
sum_MATLAB(x1, 2)

Description

Emulates the times() and ⁠.*⁠ operators from Matlab.

Usage

times(a, b)

Arguments

Details

This function basically handles elements of different length better than the * operator in R, at least as far as behavior from a Matlab user is expecting.

Value

matrix with dimensions equal to the larger of the two factors

Examples

times(9, 6)
x <- matrix(1:4, 2)
y <- c(10, 3)
print(x)
print(y)
times(x, y)
x * y

Description

Loosely mimics the functionality of the uigetfile function on Matlab.

Usage

uigetfile(filter = "", title = "")

Arguments

Value

A list containing the name of the file selected and its path

References

https://se.mathworks.com/help/matlab/ref/uigetfile.html

Examples

## Not run: 
  uigetfile()

## End(Not run)

Description

This function intends to loosely mimic the behaviour of the homonymous Matlab function.

Usage

uiputfile(filter = ".rda", title = "Save file")

Arguments

Value

A list containing the name and the path of the file to be saved

Examples

## Not run: 
  uigetfile()

## End(Not run)

Description

wrapper of zeros_or_ones() that replicates the behavior of the zeros() function on Matlab

Usage

zeros(n1, n2 = n1, ...)

Arguments

Value

An n1-by-n2 matrix of zeros

Examples

zeros(5)
zeros(5, 3)

Description

Generates a square or rectangular matrix of zeros or ones

Usage

zeros_or_ones(n, x)

Arguments

Details

This is a wrapper function to replicate the behavior of the zeros() and the ones() functions on Matlab

Value

n-by-n matrix filled with x

Note

Actually works for any x, but there's no need to bother imposing validation controls here.