ProTrackR: modLand – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

modLand

ModLand helper functions

Description

http://modland.com is on of the largest online archive of module files. These functions will assist in accessing this archive.

Usage

modLand.search.mod(search.text)

modLand.download.mod(
  format,
  author,
  title,
  mirror = c("modland.com", "ftp.modland.com", "antarctica.no", "ziphoid.com",
    "exotica.org.uk"),
  ...
)

Arguments

`search.text`	A single length `character` vector, containing search text. Provided search pattern is searched in all fields (mod format, author and title). Prefixes can be added to keywords for inclusive or exclusive searches. For details see https://www.exotica.org.uk/wiki/Modland#Searching. Note that modLand contains a wide range of tracker files, only mod-files are supported by the `ProTrackR` package. It is therefore advisable to add the keyword ‘mod’ to the search string.
`format`	A single length `character` vector, indicating the tracker file format. '`Protracker`' is the option that is most likely to work in this package.
`author`	A single length `character` vector, indicating the module author name. Can be obtained from a `modLand.search.mod`.
`title`	A single length `character` vector, indicating the module title. Can be obtained from a `modLand.search.mod`.
`mirror`	A single length `character` vector. Should contain one of the mirrors listed in the ‘usage’ section. Select a mirror site from which the module file needs to be downloaded.
`...`	Argument that are passed on to `read.module`.

Details

Like the http://modarchive.org, modland provides access to a large collection of module files. Compared to the modArchive, modLand provides limited searching features. However, it does not require an API key.

The functions documented here are provided as a convenience and depend on third party services. Note that continuity of these services cannot be guaranteed.

Use modLand.search.mod to search through the modLand collection.

Use modLand.download.mod to download a specific mod file as an S4 object.

Value

modLand.search.mod returns a data.frame. The data.frame contains a search result in each row. The data.frame contains a number of columns, each containing character strings. The column ‘title’ contains the mod file name; The column named ‘author’ contains the author name; the column named ‘format’ contains the tracker file format (only 'Protracker' is supported by this package); The collumn ‘collect’ contains modLand collections in which the mod is included; the column named ‘url’ contains a download link for the ‘ogg’-file generated on the modLand server from the mod file. Note that ogg-files are not supported by the ProTrackR package. Use modLand.download.mod to download the mod file.

modLand.download.mod attempts to download the specified mod file and return it as a PTModule object. It will throw errors when the mod file is not available or when there are network problems...

Author(s)

Pepijn de Vries

Examples

## Not run: 
## Search for a funky tune:

modland <- modLand.search.mod("elekfunk mod")

## The ogg file can be downloaded (in this case to the tempdir()),
## but it is not supported by the ProTrackR package...

utils::download.file(modland$url[1], tempdir())

## Instead, use the following approach to download the module:

mod <- modLand.download.mod(modland$format[1],
                            modland$author[1],
                            modland$title[1])


## End(Not run)

ProTrackR

Manipulate and Play 'ProTracker' Modules

v0.3.7

GPL-3

Authors

Pepijn de Vries [aut, cre, dtc]

Initial release

2020-02-03