image-methods             package:Matrix             R Documentation

_M_e_t_h_o_d_s _f_o_r _i_m_a_g_e() _i_n _P_a_c_k_a_g_e '_M_a_t_r_i_x'

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

     Methods for function 'image' in package 'Matrix'.  An image of a
     matrix

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

     ## S4 method for signature 'dgTMatrix':
     image(x,
           xlim = .5 + c(0, di[2]),
           ylim = .5 + c(di[1], 0), aspect = "iso",
           sub = sprintf("Dimensions: %d x %d", di[1], di[2]),
           xlab = "Column", ylab = "Row",
           col.regions = grey(seq(from = 0.7, to = 0, length = 100)),
           colorkey = FALSE, ...)

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

       x: a Matrix object, i.e., fulfilling 'is(x, "Matrix")'.

xlim, ylim: x- and y-axis limits; may be used to "zoom into" matrix.

  aspect: aspect ratio specified as number (y/x) or string; see
          'levelplot'.

sub, xlab, ylab: axis annotation with sensible defaults; see
          'plot.default'.

col.regions: vector of gradually varying colors; see 'levelplot'.

colorkey: logical indicating if a color key aka 'legend' should be
          produced.  Defaults to 'FALSE'.

     ...: further arguments passed to methods and 'levelplot'.

_M_e_t_h_o_d_s:

     All methods currently end up calling the method for the
     'dgTMatrix' class. Use 'showMethods(image)' to list them all.

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

     showMethods(image)
     ## If you want to see all the methods' implementations:
     showMethods(image, incl=TRUE, inherit=FALSE)

