The R Project SVN R

Rev

Rev 59039 | Rev 67389 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 59039 Rev 61433
Line 29... Line 29...
29
       first = NULL, last = NULL)
29
       first = NULL, last = NULL)
30
\method{as.person}{default}(x)
30
\method{as.person}{default}(x)
31
\method{format}{person}(x,
31
\method{format}{person}(x,
32
       include = c("given", "family", "email", "role", "comment"),
32
       include = c("given", "family", "email", "role", "comment"),
33
       braces = list(given = "", family = "", email = c("<", ">"),
33
       braces = list(given = "", family = "", email = c("<", ">"),
34
                     role = c("[", "]"), comment = c("(", ")")), 
34
                     role = c("[", "]"), comment = c("(", ")")),
35
       collapse = list(given = " ", family = " ", email = ", ",
35
       collapse = list(given = " ", family = " ", email = ", ",
36
                       role = ", ", comment = ", "),
36
                       role = ", ", comment = ", "),
37
       ...
37
       ...
38
       )
38
       )
39
}
39
}
Line 59... Line 59...
59
    an object of class \code{"person"} otherwise.}
59
    an object of class \code{"person"} otherwise.}
60
  \item{include}{a character vector giving the fields to be included
60
  \item{include}{a character vector giving the fields to be included
61
    when formatting.}
61
    when formatting.}
62
  \item{braces}{a list of characters (see \bold{Details}).}
62
  \item{braces}{a list of characters (see \bold{Details}).}
63
  \item{collapse}{a list of characters (see \bold{Details}).}
63
  \item{collapse}{a list of characters (see \bold{Details}).}
64
  \item{\dots}{currently not used.}  
64
  \item{\dots}{currently not used.}
65
}
65
}
66
\value{
66
\value{
67
  \code{person()} and \code{as.person()} return objects of class
67
  \code{person()} and \code{as.person()} return objects of class
68
  \code{"person"}.
68
  \code{"person"}.
69
}
69
}
Line 91... Line 91...
91
 
91
 
92
  \code{as.person()} is a generic function.  Its default method tries to
92
  \code{as.person()} is a generic function.  Its default method tries to
93
  reverse the default person formatting, and can also handle formatted
93
  reverse the default person formatting, and can also handle formatted
94
  person entries collapsed by comma or \code{"and"} (with appropriate
94
  person entries collapsed by comma or \code{"and"} (with appropriate
95
  white space).
95
  white space).
96
  
96
 
97
  Personal names are rather tricky, e.g.,
97
  Personal names are rather tricky, e.g.,
98
  \url{http://en.wikipedia.org/wiki/Personal_name}.
98
  \url{http://en.wikipedia.org/wiki/Personal_name}.
99
 
99
 
100
  The current implementation (starting from R 2.12.0) of the
100
  The current implementation (starting from R 2.12.0) of the
101
  \code{"person"} class uses the notions of \emph{given} (including
101
  \code{"person"} class uses the notions of \emph{given} (including
Line 118... Line 118...
118
    \item{\code{"aut"}}{(Author) Use for full authors who have made
118
    \item{\code{"aut"}}{(Author) Use for full authors who have made
119
      substantial contributions to the package and should show up in the
119
      substantial contributions to the package and should show up in the
120
      package citation.}
120
      package citation.}
121
    \item{\code{"com"}}{(Compiler) Use for persons who collected code
121
    \item{\code{"com"}}{(Compiler) Use for persons who collected code
122
      (potentially in other languages) but did not make further
122
      (potentially in other languages) but did not make further
123
      substantial contributions to the package.}  
123
      substantial contributions to the package.}
124
    \item{\code{"ctb"}}{(Contributor) Use for authors who have made
124
    \item{\code{"ctb"}}{(Contributor) Use for authors who have made
125
      smaller contributions (such as code patches etc.) but should not
125
      smaller contributions (such as code patches etc.) but should not
126
      show up in the package citation.}
126
      show up in the package citation.}
127
    \item{\code{"cph"}}{(Copyright holder) Use for all copyright holders.}
127
    \item{\code{"cph"}}{(Copyright holder) Use for all copyright holders.}
128
    \item{\code{"cre"}}{(Creator) Use for the package maintainer.}
128
    \item{\code{"cre"}}{(Creator) Use for the package maintainer.}