dataEnv                package:iSPlot                R Documentation

_A_n _e_n_v_i_r_o_n_m_e_n_t _t_o _s_t_o_r_e _i_n_f_o_r_m_a_t_i_o_n _a_b_o_u_t _t_h_e _d_a_t_a _s_e_t_s _t_o _b_e _p_l_o_t_t_e_d

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

     dataEnv is an environment to store the data sets and other
     information  about the data.  It is the data sets that are stored
     in dataEnv  that are available to be plotted in interactive
     scatterplots.  Currently,  there are three variables stored in
     dataEnv: defaultPlotData, dfList, and  highColor.  dataEnv
     pertains to storing information for the model in the 
     model-view-controller paradigm.

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

     defaultPlotData is a list that contains plot information that must
     be  stored with every data set.  The information in
     defaultPlotData is  color, pch, highlit and hide.  These will be
     added as columns to each  data set that is loaded in dfList.  For
     now, the default values for  these variables are color="black",
     pch=1, highlit=FALSE, and hide=FALSE.   Color is the color the row
     will be drawn in, pch is the plotting  character for that row,
     highlit is whether that row is highlighted, and  hide is whether
     that row is hidden.  The default values for these  variables can
     be changed by changing defaultPlotData.

     dfList is the variable that stores the data sets that will be
     plotted.   dfList is a list where each element is also a list,
     which contains two  elements, curDF and origDF.  So the first
     element of dfList would be a  list that contains curDF and origDF,
     where curDF is the current state  of the data set and origDF is
     the original state of the data set.  Any  changes that are made to
     the data set after it is added to dfList will  only occur in
     curDF.  When a data set is reset, curDF is set to origDF and all
     changes will be permanently removed. 

     highColor assigns what color will be shown when a point is
     highlighted.   The default value for highColor is "red".

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

       # list the environment variables in dataEnv
       ls(env=dataEnv)
       # return one of the environment variables
       get("defaultPlotData",dataEnv)

