statnetStartupMessage {statnet.common} | R Documentation |
This function uses information returned by packageDescription
to construct a standard package startup message
according to the policy of the Statnet Project. To determine
institutional affiliation, it uses a lookup table that maps domain
names to institutions. (E.g., *.uw.edu or *.washington.edu maps to
University of Washington.)
statnetStartupMessage(pkgname, friends, nofriends)
pkgname |
Name of the package whose information is used. |
friends |
This argument is required, but will only be interpreted if the Statnet Project policy makes use of "friendly" package information. A character vector of names of packages whose attribution
information incorporates the attribution information of this
package, or If |
nofriends |
This argument controls the startup message if the Statnet Project policy does not make use of "friendly" package information but does make use of whether or not the package is being loaded directly or as a dependency. If |
A string containing the startup message, to be passed to the
packageStartupMessage
call or NULL
, if policy
prescribes printing R's default startup message. (Thus, if
statnetStartupMessage
returns NULL
, the calling
package should not call packageStartupMessage
at all.)
Note that arguments to friends
and nofriends
are merely
requests, to be interpreted (or ignored) by the
statnetStartupMessage
according to the Statnet Project policy.
packageDescription
## Not run: .onAttach <- function(lib, pkg){ sm <- statnetStartupMessage("ergm", friends=c("statnet","ergm.count","tergm"), nofriends=FALSE) if(!is.null(sm)) packageStartupMessage(sm) } ## End(Not run)