ProTrackR2 (version 0.1.1)

format.pt2mod: Implementation of basic S3 methods

Description

Implementation of basic S3 methods, such as, format, print, as.raw and as.character ( see usage section for a complete overview). See vignette('s3class') for an overview of ProTrackR2 S3 class objects. See usage section for an overview of available methods.

Usage

# S3 method for pt2mod
format(x, ...)
# S3 method for pt2mod
print(x, ...)
# S3 method for pt2pat
format(
  x,
  padding = " ",
  empty_char = "-",
  fmt = getOption("pt2_cell_format"),
  ...
)
# S3 method for pt2command
as.character(x, ...)
# S3 method for pt2command
format(x, fmt = getOption("pt2_effect_format"), ...)
# S3 method for pt2command
print(x, max.print = 10L, ...)
# S3 method for pt2pat
print(x, sep = "  ", show_header = TRUE, show_row = TRUE, ...)
# S3 method for pt2pat
as.character(x, ...)
# S3 method for pt2celllist
as.raw(x, ...)
# S3 method for logical
as.raw.pt2celllist(x, compact = TRUE, ...)
# S3 method for pt2pat
as.raw(x, ...)
# S3 method for logical
as.raw.pt2pat(x, compact = TRUE, ...)
# S3 method for pt2cell
format(
  x,
  padding = " ",
  empty_char = "-",
  fmt = getOption("pt2_cell_format"),
  ...
)
# S3 method for pt2cell
print(x, ...)
# S3 method for pt2cell
as.character(x, ...)
# S3 method for pt2celllist
as.character(x, ...)
# S3 method for pt2command
as.raw(x, ...)
# S3 method for pt2cell
as.raw(x, ...)
# S3 method for logical
as.raw.pt2cell(x, compact = TRUE, ...)
# S3 method for pt2samp
format(x, ...)
# S3 method for pt2samp
print(x, ...)
# S3 method for pt2patlist
format(x, ...)
# S3 method for pt2patlist
print(x, ...)
# S3 method for pt2celllist
format(x, ...)
# S3 method for pt2celllist
print(x, ...)
# S3 method for pt2samplist
format(x, ...)
# S3 method for pt2samplist
print(x, ...)
# S3 method for pt2mod
as.raw(x, ...)
# S3 method for pt2samp
as.raw(x, ...)
# S3 method for pt2samp
as.integer(x, ...)
# S3 method for pt2celllist
length(x, ...)
# S3 method for pt2command
length(x, ...)

Value

The following is returned by the different methods:

• format: a formatted character representation of the object

• print: same as format

• as.character: same as format

• as.raw: a raw representation of the object. In many cases it inherits the same class as x

• as.integer: converted raw 8 bit sample data to signed pulse code modulation integer values between -128 and +127.

• length returns number of elements in x

Arguments

x

Object to apply S3 method to. See 'usage' section for allowed object types.

...

Passed on to other methods.

padding

A vector of character strings used to pad between note and instrument number (element 1) and between instrument number and effect command (element 2). Values are recycled.

empty_char

A vector of single character values used to represent empty pattern elements. First element is used for notes, second for instrument number, the third for effect commands (see also vignette("effect_commands")). Values are recycled.

fmt

Experimental feature to format a pt2cell. It should be a named list containing formatting strings for elements in the cell. It should contain the elements "note", "padding", "instrument" and "effect". Its implementation may change in future releases.

max.print

Maximum number of elements to be printed.

sep

A separator character string for concatenating pattern table columns (i.e. channels).

show_header

A logical value indicating if a header should be shown for the pattern table.

show_row

A logical value indicating if the row of a pattern table should be labelled with its index.

compact

Should the pattern be formatted using a compact notation (as used for file storage), or a none-compact format as used by the player? This can be set with the compact argument.

Examples

## First create some ProTrackR2 objects to which
## S3 methods can be applied:

mod      <- pt2_read_mod(pt2_demo())
patterns <- mod$patterns
pattern  <- patterns[[1]]
cells    <- pattern[1:4,1]
cell     <- cells[[1]]
samples  <- mod$samples
sample   <- samples[[1]]
cmnd     <- pt2_command(cell)

## Let's go wild with S3 methods:
print(mod)
print(patterns)
print(pattern)
print(cells)
print(cell)
print(samples)
print(sample)
print(cmnd)

format(mod)
format(patterns)
format(pattern)
format(cells)
format(cell)
format(samples)
format(sample)
format(cmnd)

as.character(pattern)
as.character(cells)
as.character(cell)
as.character(cmnd)

as.raw(mod)
as.raw(pattern)
as.raw(cells)
as.raw(cell)
as.raw(sample)
as.raw(cmnd)

as.integer(sample)