setArgsList            package:tkWidgets            R Documentation

_F_u_n_c_t_i_o_n_s _t_o _s_u_p_p_o_r_t _i_m_p_o_r_t_W_i_z_a_r_d

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

     The functions are to support importWizard and may not have much
     practical use otherwise.

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

     setArgsList(filename, env, isFile = TRUE, init = TRUE)
     whatDeli(delimiter)
     getMoreArgs()
     assignArgs(value, env)
     getArgs(env)
     assignShowNum(value, env)
     getShowNum(env)
     assignCState(value, env)
     getCState(env)
     assignColInfo(value, env)
     getColInfo(env)
     setColInfos(types, env)
     changeState(canvas, backBut, nextBut, env, forward = TRUE, endBut, viewBut)
     setNewState(env, backBut, nextBut, forward = TRUE, endBut, viewBut)
     addArgs(env)
     dropArgs(env)
     setSkip(widget, env, state = "state1")
     moreArgs(env)
     dropColumn(index, env)
     setColName(index, entryBox, env)
     setColType(index, entryBox, env)
     assignLineData(lineData, env)
     getLineData(env)

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

filename: 'filename' a character string for the full name of a file

     env: 'env' an R environment object for storing information

delimiter: 'delimiter' a character string for the delimiter whose
          letter representation is sought

   value: 'value' a character or numerical value to be assigned to a
          variable

 backBut: 'backBut' a tkwin object for the button that shifts back to
          the previous state

 nextBut: 'nextBut' a tkwin object for the button that shifts to the
          next state

 forward: 'forward' a boolean indicating the direction of state change

  widget: 'widget' a tcltl widget

   state: 'state' a character string for the state of importing process

   index: 'index' an integer for the index of the list for column
          information

entryBox: 'entryBox'

  canvas: 'canvas' a tcltk canvas

   types: 'types' a vecter of string indicating the types of data
          columns

lineData: 'lineData' a vector of character strings read in using
          'readLines'

  endBut: 'endBut' a tkwin object for the button that ends the process
          when pressed

 viewBut: 'viewBut' a tkwin object for the button that refresh the
          window when pressed

    init: 'init' a boolean that is TRUE when the widget is first set up
          and FALSE otherwise

  isFile: 'isFile' a boolean that is TRUE if 'fileName' is a file

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

     'setArgsList' calls function 'guess.sep' to figure out the the
     header, sep, and data type of a file and sets the values for
     argument list and colInfo.

     'whatDeli' gets the word representation of delimiters (e.g. tab
     for "\t").

     'getMoreArgs' generates a widget using widgetTools to collect some
     of the arguments for read.table.

     'assignArgs' updates "argsList" stored in a predefined
     environment. 

     'getArgs' Gets "argsList" from a predefined environment.

     'assignShowNum' Updates the value for "showNum" (number of rows to
     show in the interface.

     'getShowNum' Gets the value for "showNum" (number of rows to show
     in the interface. 

     'link{assignCState}' Updates the value of "currentState" that is
     stored in a predefined environment.

     'getCState' Gets the vlaue of "currentState" that is stored in a
     predefined environment.

     'assignColInfo' Updates the values of "colInfos" (column
     information) that is stroed in a predefined environment.

     'getColInfo' Gets the values of "colInfos" (column information)
     that is stroed in a predefined environment.

     'setColInfos' Creates colInfo objects and sets the value of
     'colInfos' list.

     'changeState' changes the state and thus the interface of a
     widget.

     '\ling{setNewState}' sets the state of a importing process.

     'addArgs' adds a new state to the argument list for states.

     'dropArgs' removes a state from the argument list for states.

     'setSkip' Sets the value for the number of lines to skip when
     readling a data file.

     'moreArgs' Gets some of the arguments for importing data using
     'read.table'.

     'dropColumn' Sets the index values for data columns that are going
     to be droped when read using 'read.table'.

     'setColName' Sets the column names for a data file by getting
     column names from correct entry boxes.

     'setColType' Sets the column type for a data file by getting
     column type information from correct entry boxes.

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

     'whatDeli' returns a character string.

     'getMoreArgs' returns a list of arguments.

     'getArgs' returns a list of the arguments for read.table.

     'getShowNum' returns an integer for the number of rows to show.

     'getCState' returns a character string for the current state.

     'getColInfo' returns a colInfo object contains column information.

_N_o_t_e:

     The functions are part of the Bioconductor project at Dana-Farber
     Cancer Institute to provide Bioinformatics funcitonalities through
     R

_A_u_t_h_o_r(_s):

     Jianhua Zhang

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

     'importWizard'

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

       # No example is given as functions require the set up of the working
       # environment. 

