leaps               package:subselect               R Documentation

_A _L_e_a_p_s _a_n_d _B_o_u_n_d_s _A_l_g_o_r_i_t_h_m _f_o_r _f_i_n_d_i_n_g _t_h_e _b_e_s_t _v_a_r_i_a_b_l_e _s_u_b_s_e_t_s

_D_e_s_c_r_i_p_t_i_o_n:

     An exact Algorithm for optimizing criteria that measure the 
     quality of k-dimensional variable subsets as approximations to a
     given set of variables, or to a set of its Principal Components.

_U_s_a_g_e:

     leaps(mat,kmin=1,kmax=ncol(mat)-1,nsol=1,exclude=NULL,include=NULL,
     criterion="RM",pcindices=NULL,timelimit=15)

_A_r_g_u_m_e_n_t_s:

     mat: a covariance or correlation matrix of the variables from
          which the k-subset is to be selected.

    kmin: the cardinality of the smallest subset that is wanted.

    kmax: the cardinality of the largest subset that is wanted.

    nsol: the number of different subsets of each cardinality that are
          requested .

 exclude: a vector of variables (referenced by their row/column numbers
          in matrix 'mat') that are to be forcibly excluded from the
          subsets.

 include: a vector of variables (referenced by their row/column numbers
          in matrix 'mat') that are to be forcibly included in the
          subsets.

criterion: Character variable, which indicates which criterion is to be
          used in judging the quality of the subsets. Currently, only
          the RM, RV and GCD criteria are supported, and referenced as
          "RM", "RV" or "GCD" (see References, 'rm.coef',  'rv.coef'
          and 'gcd.coef' for further details).

pcindices: a vector of ranks of Principal Components that are to be
          used for comparison with the variable subsets (for the GCD
          criterion only, see 'gcd.coef'). _This is a compulsory
          argument for the 'leaps' function, when the GCD criterion is
          requested_.

timelimit: a user specified limit (in seconds) for the maximum time 
          allowed to conduct the search. After this limit is exceeded,
          leaps exits with a waring message stating that it was not
          possible to find the otpimal subsets within the allocated
          time.

_D_e_t_a_i_l_s:

     For each cardinality k (with k ranging from 'kmin' to 'kmax'),
     leaps performs a branch and bound search for the best 'nsol'
     variable  subsets according to a specified criterion. Leaps
     implements Duarte Silva's  adaptation (Reference 2) of Furnival
     and Wilson's Leaps and Bounds Algorithm   (Reference 3) for
     variable selection in Regression Analysis. If the search is  not
     completed within an user defined time limit,leaps exits with a
     warning  message. 

     The user may force variables to be included and/or excluded from
     the _k_-subsets.

     In order to improve computation times, the bulk of computations
     are carried out by C++ routines. Further details about the
     Algorithm can  be found in References 2 and 3 and in the comments
     to the C++ code. A discussion of the criteria considered can be
     found in Reference 1.

_V_a_l_u_e:

     A list with five items:

 subsets: An 'nsol' x 'kmax' x length('kmin':'kmax') 3-dimensional 
          array, giving for each cardinality (dimension 3) and each
          solution (dimension 1) the list of variables (referenced by
          their row/column numbers in matrix 'mat') in the subset
          (dimension 2). (For cardinalities  smaller than 'kmax', the
          extra final positions are set to zero).

  values: An 'nsol' x length('kmin':'kmax') matrix, giving for each
          cardinality (columns), the criterion values of the best
          'nsol' (rows) subsets according to the chosen criterion.

bestvalues: A length('kmin':'kmax') vector giving the overall best
          values of the criterion for each cardinality.

bestsets: A length('kmin':'kmax') x 'kmax' matrix, giving, for each
          cardinality (rows), the variables (referenced by their
          row/column numbers in matrix 'mat') in the best k-subset.

    call: The function call which generated the output.

_R_e_f_e_r_e_n_c_e_s:

     1) Cadima, J. and Jolliffe, I.T. (2001). Variable Selection and
     the Interpretation of Principal Subspaces, _Journal of
     Agricultural, Biological and Environmental Statistics_, Vol. 6,
     62-79.

     2) Duarte Silva, A.P. (2002) Discarding Variables in a Principal 
     Component Analysis: Algorithms for All-Subsets Comparisons,
     _Computational Statistics_, Vol. 17, 251-271.

     3) Furnival, G.M. and Wilson, R.W. (1974). Regressions by Leaps
     and Bounds, _Technometrics_, Vol. 16, 499-511.

_S_e_e _A_l_s_o:

     'rm.coef', 'rv.coef', 'gcd.coef', 'anneal', 'genetic',  'improve'.

_E_x_a_m_p_l_e_s:

     # For illustration of use, a small data set with very few iterations
     # of the algorithm. 

     data(swiss)
     leaps(cor(swiss),nsol=3,criterion="RM")

     ##$subsets
     ##, , Card.1
     ##
     ##           Var.1 Var.2 Var.3 Var.4 Var.5
     ##Solution 1     3     0     0     0     0
     ##Solution 2     1     0     0     0     0
     ##Solution 3     4     0     0     0     0
     ##
     ##, , Card.2
     ##
     ##           Var.1 Var.2 Var.3 Var.4 Var.5
     ##Solution 1     3     6     0     0     0
     ##Solution 2     4     5     0     0     0
     ##Solution 3     1     2     0     0     0
     ##
     ##, , Card.3
     ##
     ##           Var.1 Var.2 Var.3 Var.4 Var.5
     ##Solution 1     4     5     6     0     0
     ##Solution 2     1     2     5     0     0
     ##Solution 3     3     4     6     0     0
     ##
     ##, , Card.4
     ##
     ##           Var.1 Var.2 Var.3 Var.4 Var.5
     ##Solution 1     2     4     5     6     0
     ##Solution 2     1     2     5     6     0
     ##Solution 3     1     4     5     6     0
     ##
     ##, , Card.5
     ##
     ##           Var.1 Var.2 Var.3 Var.4 Var.5
     ##Solution 1     1     2     3     5     6
     ##Solution 2     1     2     4     5     6
     ##Solution 3     2     3     4     5     6
     ##
     ##
     ##$values
     ##              card.1    card.2    card.3    card.4    card.5
     ##Solution 1 0.6729689 0.8016409 0.9043760 0.9510757 0.9804629
     ##Solution 2 0.6286185 0.7982296 0.8791856 0.9506434 0.9776338
     ##Solution 3 0.6286130 0.7945390 0.8777509 0.9395708 0.9752551
     ##
     ##$bestvalues
     ##   Card.1    Card.2    Card.3    Card.4    Card.5 
     ##0.6729689 0.8016409 0.9043760 0.9510757 0.9804629 
     ##
     ##$bestsets
     ##       Var.1 Var.2 Var.3 Var.4 Var.5
     ##Card.1     3     0     0     0     0
     ##Card.2     3     6     0     0     0
     ##Card.3     4     5     6     0     0
     ##Card.4     2     4     5     6     0
     ##Card.5     1     2     3     5     6
     ##
     ##$call
     ##leaps(cor(swiss), nsol = 3, criterion = "RM")

     #
     #
     # Asking only for 2- and 3- dimensional subsets and excluding 
     # variable number 6.
     # 

     data(swiss)
     leaps(cor(swiss),2,3,exclude=6,nsol=3,criterion="RM")

     ##$subsets
     ##, , Card.2
     ##
     ##           Var.1 Var.2 Var.3
     ##Solution 1     4     5     0
     ##Solution 2     1     2     0
     ##Solution 3     1     3     0
     ##
     ##, , Card.3
     ##
     ##           Var.1 Var.2 Var.3
     ##Solution 1     1     2     5
     ##Solution 2     1     4     5
     ##Solution 3     2     4     5
     ##
     ##
     ##$values
     ##              card.2    card.3
     ##Solution 1 0.7982296 0.8791856
     ##Solution 2 0.7945390 0.8686515
     ##Solution 3 0.7755232 0.8628693
     ##
     ##$bestvalues
     ##   Card.2    Card.3 
     ##0.7982296 0.8791856 
     ##
     ##$bestsets
     ##       Var.1 Var.2 Var.3
     ##Card.2     4     5     0
     ##Card.3     1     2     5
     ##
     ##$call
     ##leaps(cor(swiss), 2, 3, exclude = 6, nsol = 3, criterion = "RM")

     #
     # Searching for 2- and 3- dimensional subsets that best approximate the 
     # spaces generated by the first three Principal Components
     #

     data(swiss)
     leaps(cor(swiss),2,3,criterion="gcd",pcindices=1:3,nsol=3)

     ##$subsets
     ##, , Card.2
     ##
     ##           Var.1 Var.2 Var.3
     ##Solution 1     4     5     0
     ##Solution 2     5     6     0
     ##Solution 3     4     6     0
     ##
     ##, , Card.3
     ##
     ##           Var.1 Var.2 Var.3
     ##Solution 1     4     5     6
     ##Solution 2     3     5     6
     ##Solution 3     2     5     6
     ##
     ##
     ##$values
     ##              card.2    card.3
     ##Solution 1 0.7831827 0.9253684
     ##Solution 2 0.7475630 0.8459302
     ##Solution 3 0.7383665 0.8243032
     ##
     ##$bestvalues
     ##   Card.2    Card.3 
     ##0.7831827 0.9253684 
     ##
     ##$bestsets
     ##       Var.1 Var.2 Var.3
     ##Card.2     4     5     0
     ##Card.3     4     5     6
     ##
     ##$call
     ##leaps(cor(swiss), 2, 3, criterion = "gcd", pcindices = 1:3, nsol = 3)

