bios2mds (version 1.2.2)

col.group: Links elements in a mmds object to specific groups and colors

Description

Links elements in a mmds object or mmds.project object to user-provided groups and colors.

Usage

col.group(x,file)

Arguments

x

a 'mmds' or 'project' object obtained from mmds or mmds.project function

file

a string of characters to indicate the file name assigning groups and colors to each active OR each supplementary element of the mmds object.

Value

Adds data to a mmds object in order to color and label mmds scatter plots with user-provided groupings and colors.

Details

col.group assigns each element of the mmds object to user-provided groupings and colors for coloring and labeling mmds scatter plots.

col.group requires a formatted file. See "csv/human_gpcr_group.csv" for an example. Each line corresponds to one element of the mmds object and must contain three parameters separated by ",". The first parameter is the element name, as given in the multiple sequence alignment file. The second parameter is the group name. Groupings must be provided by the user. The third parameter is the group color in full letters (example : "black","green"). Two or more groups can have the same color, but elements within the same group must have the same color. The group is colored by the first color encountered.

See Also

See colors function (default R package). See getcol in made4 package for special color palette developed to maximize the contrast between colors.

Examples

# NOT RUN {
# performing metric MDS on human GPCRs with projection of 
# GPCRs from D. melanogaster as supplementary data:
data(gpcr)
active <- gpcr$dif$sapiens.sapiens
mmds_active <- mmds(active)
mmds_active<-col.group(mmds_active,system.file("csv/human_gpcr_group.csv"
,package = "bios2mds"))
# }