procmod.frame.R 7.17 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
#' @include internals.R
NULL

#' Internal function repeating a matrix.
#'
#' @description repeats several times the rows of a matrix
#'              to create a new matrix with more rows. The
#'              final row count must be a multiple of the
#'              initial row count
#'
#' @param x  The matrix to replicate
#' @param length.out  an interger value specifying the number of row
#'                    of the returned matrix
#'
#' @return a new matrix with the same number of columns but with `length.out`
#'         rows.
#'
#' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima
#'

.rep_matrix = function(x,length.out) {
  N = nrow(x)

  if ((length.out%%N != 0L))
    stop(sprintf("The size of the longest object (%d) is not a multiple of the size of the shortest (%d)",
                 nrows,N),
         domain = NA)

  rep=x
  while (nrow(rep) < length.out)
    rep = rbind(rep,x)

  return(rep)
}

.procmod_coerce_value = function(x,nrows=0) {
  xi <- if (is.data.frame(x))
    as.matrix(x)
  else if (is.matrix(x))
    x
  else
    as.matrix(x)

  dxi = dim(xi)
  if (is.null(dxi))
    dxi=c(1,1)

  rownamesi = rownames(xi)
  colnamesi = colnames(xi)

  xi  = as.numeric(xi)

  dim(xi)=dxi
  rownames(xi) = rownamesi
  colnames(xi) = colnamesi

  N = nrow(xi)

  if (nrows > 0L && N < nrows)
    if (N > 0L && (nrows%%N == 0L))
      xi <- .rep_matrix(xi, length.out = nrows)
  else stop(sprintf(ngettext(N, "replacement has %d row, data has %d",
                             "replacement has %d rows, data has %d"),
                    N, nrows),
            domain = NA)

  return(xi)
}

#' Build a procmod.frame data structure.
#'
#' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima
#' @export
procmod.frame = function(...,
                         row.names = NULL,
                         check.rows = FALSE,
                         check.names = TRUE,
80
                         reorder.rows = FALSE)
81
{
82
  has.row.names    = ! missing(row.names)
83 84 85 86 87 88

  varnames = dots.names(...)

  x <- list(...)
  n <- length(x)

89 90
  if ((! has.row.names || is.null(row.names)) && n >= 1)
    row.names = rownames(x[[1]])
91

92
  nrows <- integer(n)
93
  value <- vector(mode = "list", length = n)
94

95 96 97 98 99 100 101 102 103 104
  names(value)=varnames

  types <- character(n)

  for (i in seq_len(n)) {
    if (i==1)
      xi <- .procmod_coerce_value(x[[i]])
    else
      xi <- .procmod_coerce_value(x[[i]],
                                  nrows = nrows[1])
105 106 107 108 109 110

    if (reorder.rows &&
        ! is.null(row.names) &&
        ! is.null(rownames(xi)))
      xi=xi[row.names,]

111 112 113 114 115
    nrows[i] <- nrow(xi)
    value[[i]]=xi
  }

  stopifnot(all(nrows[i]==nrows))
116
  message(row.names," : ",length(row.names),",",nrows[i])
117 118
  if (length(row.names)==nrows[i]) {
    attr(value,"row.names")=row.names
119 120 121 122 123 124 125 126
    if (check.rows)
      for (i in seq_len(n)) {
        if (! all(row.names == rownames(value[[i]])))
          stop("Row names among matrices are not consistant")
      }
    else
      for (i in seq_len(n))
        rownames(value[[i]])=row.names
127
  }
128 129 130 131
  else
    for (i in seq_len(n))
      rownames(value[[i]])=NULL

132 133 134 135 136 137 138 139 140 141 142 143 144
  return(make_subS3Class(value, "procmod.frame"))
}


#' Check if an object is a Matrix Frame.
#'
#' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima
#' @export
is.procmod.frame = function(x) {
  inherits(x, "procmod.frame")
}

145
#' Coerce to a ProcMod Frame.
146 147 148 149
#'
#' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima
#' @export
150
as.procmod.frame = function(data,...) {
151 152 153 154 155 156 157 158
  UseMethod("as.procmod.frame",data)
}

#' Coerce to a ProcMod Frame.
#'
#' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima
#' @export
159 160
as.procmod.frame.list = function(data,...) {
  do.call(procmod.frame,data,...)
161 162 163 164 165 166 167
}

#' Coerce to a ProcMod Frame.
#'
#' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima
#' @export
168
as.procmod.frame.procmod.frame = function(data,...) {
169 170 171 172 173 174 175 176
  data
}

#' Coerce to a ProcMod Frame.
#'
#' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima
#' @export
177
as.procmod.frame.array = function(data,...) {
178 179 180 181 182 183 184 185 186
  di = dim(data)
  stopifnot(length(di)==3)

  l = lapply(seq_len(di[3]),
             function(i) data[,,i])

  if (length(attr(data,"dimnames"))==3)
    names(l)=attr(data,"dimnames")[[3]]

187
  do.call(procmod.frame,l,...)
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
}

#' Dimensions of a Matrix Frame.
#'
#' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima
#' @export
dim.procmod.frame = function(x)
  return(c(nrow(x[[1]]),length(x)))

#' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima
#' @export
`[[<-.procmod.frame` = function (x, i, value)
{
  cl = class(x)
  nrows=nrow(x)
  class(x)="list"

  if (!is.null(value)) {
    value=.procmod_coerce_value(value,nrows)
    N <- nrow(value)

    if (N > nrows)
      stop(sprintf(ngettext(N, "replacement has %d row, data has %d",
                            "replacement has %d rows, data has %d"),
                   N, nrows),
           domain = NA)

    if (N < nrows)
      stop(sprintf(ngettext(N, "replacement has %d row, data has %d",
                            "replacement has %d rows, data has %d"),
                   N, nrows),
           domain = NA)

  }

225
  rownames(value)=attr(x,"row.names")
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244

  x[[i]] <- value
  class(x)=cl

  return(x)
}

#' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima
#' @export
`$<-.procmod.frame` = function (x, name, value) {
  x[[name]] <- value
  return(x)
}

#' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima
#' @export
`[.procmod.frame` = function (x, i, j,
245
                              drop = TRUE)
246 247 248 249 250 251
{
  has.j    = !missing(j)
  has.i    = !missing(i)
  has.drop = !missing(drop)
  Narg = nargs() - 2 + (has.i | has.j | has.drop) - has.drop

252
  message("Nargs = ",Narg," i:",has.i," j:",has.j," drop:",has.drop)
253 254 255 256

  if (!all(names(sys.call()) %in% c("", "drop")))
    warning("named arguments other than 'drop' are discouraged")

257

258
  if (! has.i && ! has.j)
259
      # Case 1 : X[]
260
      return(x)
261 262 263 264
  else if (! has.i && has.j) {
    # Case 2 : X[,j] ou x[i]
    message('Case 2 : X[,j]')
      y <- as.list(x)[j]
265
  }
266 267 268 269
  else if ( has.i && Narg==1) {
    # Case 3 : X[,j] ou x[i]
    message('Case 3 : X[i]')
    y <- as.list(x)[i]
270
  }
271 272 273
  else if ( has.i && !has.j && Narg>1) {
    # Case 4 : X[i,]
    message('Case 4 : X[i,]')
274
    y = lapply(x, function(m) m[i,,drop=FALSE])
275 276 277 278 279
  }
  else if ( has.i && has.j ) {
    message('Case 5 : X[i,j]')
    y = x[j,drop=FALSE]
    y = y[i,,drop=FALSE]
280 281
  }

282 283 284 285 286
  if (drop && length(y)==1L)
    y = y[[1]]
  else {
    y = make_subS3Class(y, "procmod.frame")
    attr(y,"row.names")=rownames(y[[1]])
287
  }
288 289

  return(y)
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
}

#' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima
#' @export
subset.procmod.frame = function (x, subset, select, drop = FALSE, ...)
{
  r <- if (missing(subset))
    rep_len(TRUE, nrow(x))
  else {
    e <- substitute(subset)
    r <- eval(e, x, parent.frame())
    if (!is.logical(r))
      stop("'subset' must be logical")
    r & !is.na(r)
  }
  vars <- if (missing(select))
    TRUE
  else {
    nl <- as.list(seq_along(x))
    names(nl) <- names(x)
    eval(substitute(select), nl, parent.frame())
  }
  x[r, vars, drop = drop]
}

#' @author Eric Coissac
#' @author Christelle Gonindard-Melodelima
#' @export
as.list.procmod.frame = function(x, ...) {
  class(x)='list'
  return(x)
}