The R Project SVN R

Rev

Rev 85983 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 85983 Rev 86005
Line 13... Line 13...
13
          strict = FALSE, grep = FALSE, global = FALSE,
13
          strict = FALSE, grep = FALSE, global = FALSE,
14
          no.match = character(), vpPath = viewports)
14
          no.match = character(), vpPath = viewports)
15
}
15
}
16
%- maybe also 'usage' for other objects documented here.
16
%- maybe also 'usage' for other objects documented here.
17
\arguments{
17
\arguments{
18
  \item{path}{ a gPath or a vpPath or a character value that could be
18
  \item{path}{ a \I{gPath} or a \I{vpPath} or a character value that could be
19
    interpreted as either. }
19
    interpreted as either. }
20
  \item{x}{ a grob or \code{NULL}.  If \code{NULL}, the display list
20
  \item{x}{ a grob or \code{NULL}.  If \code{NULL}, the display list
21
    is searched.
21
    is searched.
22
  }
22
  }
23
  \item{grobs}{A logical value indicating whether to search for grobs.}
23
  \item{grobs}{A logical value indicating whether to search for grobs.}
Line 37... Line 37...
37
  }
37
  }
38
  \item{no.match}{
38
  \item{no.match}{
39
    The value to return if no matches are found.
39
    The value to return if no matches are found.
40
  }
40
  }
41
  \item{vpPath}{
41
  \item{vpPath}{
42
    A logical value indicating whether to return the vpPath for each
42
    A logical value indicating whether to return the \I{vpPath} for each
43
    grob as an attribute of the result.
43
    grob as an attribute of the result.
44
  }
44
  }
45
}
45
}
46
\value{
46
\value{
47
  Either a \I{gPath} or a \I{vpPath} or,
47
  Either a \I{gPath} or a \I{vpPath} or,
48
  if \code{global} is \code{TRUE} a list of \I{gPath}s and/or \I{vpPath}s.
48
  if \code{global} is \code{TRUE} a list of \I{gPath}s and/or \I{vpPath}s.
49
 
49
 
50
  If \code{vpPath} is \code{TRUE}, each gPath result will have an
50
  If \code{vpPath} is \code{TRUE}, each \I{gPath} result will have an
51
  attribute \code{"vpPath"}.
51
  attribute \code{"vpPath"}.
52
  
52
  
53
  If there are no matches, \code{no.match} is returned.
53
  If there are no matches, \code{no.match} is returned.
54
}
54
}
55
 
55