gm (version 1.0.2)

Key: Create Key Object

Description

Create a Key object.

Key objects represent key signatures.

Usage

Key(key, bar = NULL, to = NULL, scope = NULL)

Value

A list with class Key.

Arguments

key

An integer between -7 and 7, which indicates the number of flat or sharp symbols in the key signature.

bar

Optional. A positive integer which indicates the number of the measure into which to insert the Key object. By default, a Key object will be inserted into the first measure(s).

to

Optional. A positive integer or a single character which indicates the Line object to which to add the Key object. By default, a Key object will be added to a whole Music object rather than to any specific Line object.

scope

Optional. "part" or "staff", which indicates whether to add the Key object to a whole part or only to a staff of a part, if the argument to is specified, or this argument will be ignored. The default value is "part".

See Also

+.Music() for adding Key objects to a Music object.

Examples

# create a Key object
Key(-7)

# insert a Key object into a specific measure
Music() + Key(7, bar = 2)

m <- Music() +
  Line(list("E5"), list(1), name = "a") +
  Line(list("C4"), list(1), name = "b", as = "staff")

# add a Key to a part
m + Key(2, to = "b")

# add a Key to a staff
m + Key(2, to = "b", scope = "staff")