pickFrom {relimp}R Documentation

Pick Subsets from a Vector

Description

Provides a Tk dialog for interactive selection of one or more subsets from a vector. Requires the tcltk package.

Usage

pickFrom(vec, nsets = 1, return.indices = FALSE,
                 setlabels = NULL, edit.setlabels = TRUE,
                 subset = TRUE,
                 warningText = "one or more selections empty",
                 title = "Subset picker",
                 items.label = "Pick from:",
                 labels.prompt = "Your label for this set:",
                 list.height = 20,
                 items.scrollbar = TRUE,
                 preserve.order = TRUE,
                 listFont = "Courier 12",
                 labelFont = "Helvetica 11",
                 windowPos = "+150+30")

Arguments

vec a vector
nsets a positive integer, the number of subsets to be selected
return.indices logical, whether indices (TRUE) or vector contents (FALSE) are to be returned
setlabels a character vector of labels for the subsets
edit.setlabels logical, determines whether a textbox is provided for editing the label of each subset
subset logical, character or numeric vector indicating which elements of vec should be made available for selection. Default is to make all elements available.
warningText character, text to use as a warning in situations where no selection is made into one or more of the specified sets
title character, title of the Tk dialog window
items.label character, a label for the set of items to be selected from
labels.prompt character, a prompt for textual set label(s)
list.height maximum number of elements of vec to display at once
items.scrollbar logical, whether a scrollbar is to be provided when vec is longer than list.height
preserve.order logical: should the order of items in vec be maintained in all of the returned subsets?
listFont a Tk font specification for the items list and subsets
labelFont a Tk font specification for the labels entrybox
windowPos position of the Tk dialog, in pixels from top left of display

Details

If return.indices is used together with subset, the indices returned relate to vec, not to vec[subset].

Value

EITHER (if the dialog is ended with "OK") a list, with nsets components. Each component is a selected sub-vector, or a numeric vector of indices for a selected sub-vector (if return.indices is TRUE). The component names are as specified in setlabels, or as specified interactively.
OR (if either "Cancel" or the close-window control button is used) NULL.

Author(s)

David Firth, d.firth@warwick.ac.uk

Examples

## This cannot be run by example() but should be OK when pasted
## into an interactive R session
## Not run: 
pickFrom(c("apple", "banana", "plum", "grapefruit"), nsets = 2,
  preserve.order = FALSE,
  setlabels = c("Fruits I like", "Fruits I tolerate"))
## End(Not run)

[Package relimp version 0.9-7 Index]