Function reference • ProTrackR

All functions

MODPlugToPTPattern(): Convert MODPlug pattern into a PTPattern object

PTBlock(<PTPattern>,<numeric>,<numeric>): Select and copy a range of PTCells into a PTBlock

PTCell-class PTCell: The PTCell class

PTCell(<raw>,<missing>,<missing>,<missing>) PTCell(<character>,<missing>,<missing>,<missing>) PTCell(<PTModule>,<numeric>,<numeric>,<numeric>) `PTCell<-`(<PTModule>,<numeric>,<numeric>,<numeric>,<PTCell>) PTCell(<PTPattern>,<numeric>,<numeric>,<missing>) `PTCell<-`(<PTPattern>,<numeric>,<numeric>,<missing>,<PTCell>) PTCell(<PTTrack>,<numeric>,<missing>,<missing>) `PTCell<-`(<PTTrack>,<numeric>,<missing>,<missing>,<PTCell>): Coerce to or replace PTCell

PTModule-class PTModule: The PTModule class

PTPattern-class PTPattern: The PTPattern class

PTPattern(<raw>,<missing>) PTPattern(<matrix>,<missing>) PTPattern(<PTModule>,<numeric>) `PTPattern<-`(<PTModule>,<numeric>,<PTPattern>): Coerce to or replace PTPattern

PTPatternToMODPlug(): Convert PTPattern data into a MODPlug pattern

PTSample-class PTSample: The PTSample class

PTSample(<Wave>,<missing>) PTSample(<raw>,<missing>) PTSample(<PTModule>,<numeric>) `PTSample<-`(<PTModule>,<numeric>,<PTSample>): Coerce to or replace PTSample

PTTrack-class PTTrack: The PTTrack class

PTTrack(<raw>,<missing>,<missing>) PTTrack(<matrix>,<missing>,<missing>) PTTrack(<character>,<missing>,<missing>) PTTrack(<PTModule>,<numeric>,<numeric>) `PTTrack<-`(<PTModule>,<numeric>,<numeric>,<PTTrack>) PTTrack(<PTPattern>,<numeric>,<missing>) `PTTrack<-`(<PTPattern>,<numeric>,<missing>,<PTTrack>): Coerce to or replace PTTrack

appendPattern(<PTModule>,<PTPattern>): Append a PTPattern to a PTModule

as.character(<PTCell>) as.character(<PTTrack>) as.character(<PTPattern>): Character representation of ProTrackR objects

as.raw(<PTCell>) `as.raw<-`(<PTCell>,<raw>) as.raw(<PTTrack>) `as.raw<-`(<PTTrack>,<matrix>) as.raw(<PTPattern>) `as.raw<-`(<PTPattern>,<matrix>) as.raw(<PTModule>): Extract and replace raw data

clearSamples(<PTModule>): Clear all samples from module

clearSong(<PTModule>): Clear all pattern info from module

deletePattern(<PTModule>,<numeric>): Remove a PTPattern table from a PTModule object

effect(<PTCell>) `effect<-`(<PTCell>,<character>): Extract or replace effect/trigger codes

fineTune(<PTSample>) `fineTune<-`(<PTSample>,<numeric>): Fine tune a PTSample

fix.PTModule(<PTModule>,<logical>) fix.PTModule(<PTModule>,<missing>): Attempt to fix PTModule to ProTracker specs

funk_table: ProTracker Funk Table

loopLength(<PTSample>) `loopLength<-`(<PTSample>): The loop length of a PTSample

loopSample(<PTSample>): Looped waveform of a sample

loopStart(<PTSample>) `loopStart<-`(<PTSample>): The loop start position of a PTSample

loopState(<PTSample>): Get PTSample loop state

mod.intro: Example of a PTModule object

modArchive.info() modArchive.download() modArchive.search.mod() modArchive.request.count() modArchive.max.requests() modArchive.view.by() modArchive.search.genre() modArchive.search.artist() modArchive.search.hash() modArchive.random.pick(): ModArchive helper functions

modLand.search.mod() modLand.download.mod(): ModLand helper functions

modToWave(<PTModule>): Convert a PTModule object into an audio Wave object

moduleSize(<PTModule>): Get module file size

name(<PTSample>) `name<-`(<PTSample>,<character>) name(<PTModule>) `name<-`(<PTModule>,<character>): Obtain or replace the name of a PTModule or PTSample

note(<numeric>) note(<PTCell>) `note<-`(<PTCell>,<character>): Extract or replace a note

noteUp(<PTCell>) noteDown(<PTCell>) octaveUp(<PTCell>) octaveDown(<PTCell>) noteUp(<PTTrack>) noteDown(<PTTrack>) octaveUp(<PTTrack>) octaveDown(<PTTrack>) noteUp(<PTPattern>) noteDown(<PTPattern>) octaveUp(<PTPattern>) octaveDown(<PTPattern>): Raise or lower notes and octaves

noteToPeriod(): Extract period value for a specific note

nybble() loNybble() hiNybble(): Get the high or low nybble of a raw value

nybbleToSignedInt(): Get signed integer values from nybbles

octave(<numeric>) octave(<PTCell>) `octave<-`(<PTCell>,<numeric>): Extract or replace an octave

pasteBlock(<PTPattern>,<matrix>,<numeric>,<numeric>): Paste a block of PTCell data into a PTPattern

patternLength(<PTModule>): Get the number of PTPattern tables in a PTModule

patternOrder(<PTModule>) `patternOrder<-`(<PTModule>,<ANY>,<numeric>): Get the pattern order table

patternOrderLength(<PTModule>) `patternOrderLength<-`(<PTModule>,<numeric>): Get the length of the pattern order table

paula_clock: Paula clock table

periodToChar(): Get the note and octave from period table

period_table: ProTracker Period Table

playMod(<PTModule>): Play PTModule objects

playSample(<PTSample>) playSample(<PTModule>): Play audio samples

playWave(<Wave>) playWave(<WaveMC>): Play Wave objects

playingtable(<PTModule>): Generate a table for playing a PTModule object

plot(<PTModule>,<missing>): Plot a PTModule object

print(<PTCell>) print(<PTTrack>) print(<PTPattern>) print(<PTSample>) print(<PTModule>): Print ProTrackR objects

proTrackerVibrato(): Get the vibrato table used by ProTracker

rawToCharNull(): Convert raw vectors into a character string

rawToPTModule(<raw>): Convert a vector of raw data into a PTModule object

rawToSignedInt(): Convert a raw vector into signed integers (short)

rawToUnsignedInt(): Convert raw vector into a single unsigned integer value

read.module(<character>,<logical>) read.module(<ANY>,<missing>) read.module(<ANY>,<missing>) read.module(<ANY>,<logical>): Read a ProTracker module file

read.sample(<character>): Read an audio file and coerce to a PTSample object

resample(): Resample data

sampleLength(<PTSample>): Get the length of a PTSample

sampleNumber(<PTCell>) `sampleNumber<-`(<PTCell>,<numeric>): Extract or replace a sample number

noteToSampleRate() periodToSampleRate(): Calculate the sample rate for a note or period value

signedIntToNybble(): Convert a signed integer to a nybble in raw data.

signedIntToRaw(): Convert signed integers (short) into a raw vector

trackerFlag(<PTModule>) `trackerFlag<-`(<PTModule>): Tracker flag indicating version compatibility

unsignedIntToRaw(): Convert unsigned integer into a raw vector

volume(<PTSample>) `volume<-`(<PTSample>,<numeric>): Default playback volume of PTSample

waveform(<PTSample>) `waveform<-`(<PTSample>): Extract or replace a PTSample waveform

write.module(<PTModule>,<ANY>) write.module(<PTModule>,<character>): Export an PTModule object as a ProTracker module file

write.sample(<PTSample>,<character>): Write a PTSample object to an audio file