write.module: Export an PTModule object as a ProTracker module file

Description Usage Arguments Details Value Author(s) References See Also Examples

Description

Export an PTModule object as a ProTracker module file, conform ProTracker 2.3A specifications.

Usage

1
2
3
4
5
## S4 method for signature 'PTModule,ANY'
write.module(mod, file)

## S4 method for signature 'PTModule,character'
write.module(mod, file)

Arguments

mod

A valid PTModule object to be saved as a ProTracker *.mod file

file

either a filename to write to, or a file connection, that allows to write binary data (see file).

Details

The routine to write ProTracker modules is based on the referenced version of ProTracker 2.3A. This means that the routine may not be able to write files that ar compatible with later or earlier ProTracker versions.

Value

Writes to a module file but returns nothing.

Author(s)

Pepijn de Vries

References

http://wiki.multimedia.cx/index.php?title=Protracker_Module

http://coppershade.org/articles/More!/Topics/Protracker_File_Format/

See Also

Other io.operations: read.module, read.sample, write.sample

Other module.operations: PTModule-class, appendPattern, clearSamples, clearSong, deletePattern, fix.PTModule, modToWave, moduleSize, patternLength, patternOrderLength, patternOrder, playMod, playingtable, read.module, trackerFlag

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## get the PTModule object provided with the ProTrackR package
data("mod.intro")

## save the object as a valid ProTracker module file:
write.module(mod.intro, "intro.mod")

## or create the connection yourself:
con <- file("intro2.mod", "wb")
write.module(mod.intro, con)

## don't forget to close the connection after you're done:
close(con)

ProTrackR documentation built on May 19, 2017, 1:37 p.m.

Search within the ProTrackR package
Search all R packages, documentation and source code