Skip to content

Commit eab5542

Browse files
committed
added requested anchors to doc links
1 parent a9fb41a commit eab5542

8 files changed

Lines changed: 15 additions & 15 deletions

man/add.active.Rd

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Convenience functions for adding a set of verticies (or edges) and setting them
2424
onset = NULL, terminus = NULL, length = NULL, at = NULL, ...)
2525
}
2626
\arguments{
27-
\item{x}{ an object of class \code{\link{network}} or \code{\link{networkDynamic}}. }
27+
\item{x}{ an object of class \code{\link[network]{network}} or \code{\link{networkDynamic}}. }
2828
\item{nv}{the number of vertices to add}
2929
\item{tail}{a vector of vertex IDs corresponding to the tail (source, ego) of each edge to be added}
3030
\item{head}{a vector of vertex IDs corresponding to the head (target, alter) of each edge to be added}
@@ -33,14 +33,14 @@ Convenience functions for adding a set of verticies (or edges) and setting them
3333
\item{terminus}{ an optional vector of time points that specifies the ends of the interval(s). This must be accompanied by one of \code{onset} or \code{length}. }
3434
\item{length}{ an optional vector of interval lengths for the interval(s). This must be accompanied by one of \code{onset} or \code{terminus}. }
3535
\item{at}{ optional, one or more time points to be activated. }
36-
\item{names.eval}{optional list of length equal to the number of edges, with each element containing a list of names for the attributes of the corresponding edge. not currently interpreted in a dynamic context, but passed directly to \code{\link{add.edges}}}
37-
\item{vals.eval}{an optional list of lists of edge attribute values (matching \code{names.eval}). Not currently interpreted in a dynamic context, but passed directly to \code{\link{add.edges}}}
38-
\item{vattr}{optionally, a list of attributes with one entry per new vertex. not currently interpreted in a dynamic context, but passed directly to \code{\link{add.vertices}}}
36+
\item{names.eval}{optional list of length equal to the number of edges, with each element containing a list of names for the attributes of the corresponding edge. not currently interpreted in a dynamic context, but passed directly to \code{\link[network]{add.edges}}}
37+
\item{vals.eval}{an optional list of lists of edge attribute values (matching \code{names.eval}). Not currently interpreted in a dynamic context, but passed directly to \code{\link[network]{add.edges}}}
38+
\item{vattr}{optionally, a list of attributes with one entry per new vertex. not currently interpreted in a dynamic context, but passed directly to \code{\link[network]{add.vertices}}}
3939
\item{last.mode}{logical; should the new vertices be added to the last (rather than the first) mode of a bipartite network?}
4040
\item{...}{possible future additional arguments}
4141
}
4242
\details{
43-
Essentially a wrapper for a call to \code{\link{add.vertices}} and \code{\link{activate.vertices}} or \code{\link{add.edges}} and \code{\link{activate.edges}} when setting up a network object. These are not the S3 methods that their name appears to imply, since there is no "active" class. See \code{\link{add.edges.networkDynamic}}, etc.
43+
Essentially a wrapper for a call to \code{\link[network]{add.vertices}} and \code{\link{activate.vertices}} or \code{\link[network]{add.edges}} and \code{\link{activate.edges}} when setting up a network object. These are not the S3 methods that their name appears to imply, since there is no "active" class. See \code{\link{add.edges.networkDynamic}}, etc.
4444
}
4545
\value{
4646
The passed in network object with class set to \code{\link{networkDynamic}} and the specified number of new vertices or edges added and activated
@@ -53,7 +53,7 @@ Ayn Leslie-Cook \email{aynlc3@uw.edu}}
5353

5454

5555
\seealso{
56-
See Also as \code{\link{activate.vertices}}, \code{\link{activate.edges}},\code{\link{add.vertices}},\code{\link{add.edges}}
56+
See Also as \code{\link{activate.vertices}}, \code{\link{activate.edges}},\code{\link[network]{add.vertices}},\code{\link[network]{add.edges}}
5757
}
5858
\examples{
5959
nw <- network.initialize(5)

man/age.at.Rd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ logical, if \code{TRUE} edges or vertices with no activity specified will be con
5151
\details{
5252
Edges or vertices that are not active at time \code{at} will return \code{NA}. For edges or vertices with multiple activity spells, this function \emph{does not} report the total duration of activity across all spells, only the duration from the start of the spell with which the \code{at} point intersects.
5353

54-
\code{dyads.age.at} reports the age of edges corresponding to each dyad (tail,head). It cannot be used with hypergraphic or multiplex networks because a pair of vertex ids may not uniquely correspond to an edge. If \code{tails} and \code{heads} are not specified, they will default to the tails and heads of all existing (but not necessarily active) edges in the network. Ordering and index position should correspond to \code{\link{valid.eids}}.
54+
\code{dyads.age.at} reports the age of edges corresponding to each dyad (tail,head). It cannot be used with hypergraphic or multiplex networks because a pair of vertex ids may not uniquely correspond to an edge. If \code{tails} and \code{heads} are not specified, they will default to the tails and heads of all existing (but not necessarily active) edges in the network. Ordering and index position should correspond to \code{\link[network]{valid.eids}}.
5555
}
5656
\value{
5757
By default, a numeric vector indicating the age of the network element at the query time point, or NA if the element is not active or (in the case of edges) deleted. Elements of the vector return correspond to the values of \code{e} or \code{v} or \code{(tails,heads)} respectively.

man/as.networkDynamic.Rd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ number of additional features for handling temporal information.
5252
when working with vertex and edge attributes that can be stored as atomic
5353
vectors. Currently, \code{networkLite}s come with the restriction that the
5454
network attributes \code{hyper}, \code{multiple}, and \code{loops} must be
55-
\code{FALSE}. See \code{\link{networkLite-package}} for more information.)
55+
\code{FALSE}. See \code{\link[networkLite]{networkLite-package}} for more information.)
5656

5757
Such conversions between network types are used when starting a dynamic
5858
simulation from a cross-sectional network and returning the simulation history
@@ -75,7 +75,7 @@ Pavel, Zack W Almquist <almquist@uci.edu>
7575
\seealso{
7676
For the inverse (removing the \code{networkDynamic} class) see
7777
\code{\link{as.network.networkDynamic}} and
78-
\code{\link{as.networkLite.network}} (which applies to \code{networkDynamic}s).
78+
\code{\link[networkLite]{as.networkLite.network}} (which applies to \code{networkDynamic}s).
7979
For extracting cross-sectional information from a \code{networkDynamic} (which
8080
is often more appropriate than simply removing the \code{networkDynamic}
8181
class), see \code{\link{network.collapse}} and \code{\link{network.extract}}.

man/is.active.Rd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Thus [onset, terminus) will be interpreted as [onset, terminus] when terminus =
6060
\item Queries for intervals specified by \code{c(Inf, Inf)} or \code{c(-Inf, -Inf)} are ignored.
6161
}
6262

63-
If the \code{e} argument includes edge ids corresponding to deleted edges, a warning will be generated because the length of the output vector will not match the vector of edge ids. In this case it is a good idea to use \code{\link{valid.eids}} to determine the edge ids.
63+
If the \code{e} argument includes edge ids corresponding to deleted edges, a warning will be generated because the length of the output vector will not match the vector of edge ids. In this case it is a good idea to use \code{\link[network]{valid.eids}} to determine the edge ids.
6464
}
6565
\value{
6666
A logical vector indicating the activity states of vertices or edges. In the case of vertices, the elements of the vector correspond to the vertex ids provided via the \code{v} paramter. In the edges case, if the network has deleted edges, they will be omited from the result so the elements of the vector may not correspond to the eids provided via the \code{e} parameter.
@@ -71,7 +71,7 @@ Thus [onset, terminus) will be interpreted as [onset, terminus] when terminus =
7171
%
7272
% ~Make other sections like Warning with \section{Warning }{....} ~
7373
%}
74-
\seealso{ \code{\link{activity.attribute}}, \code{\link{activate}}, \code{\link{valid.eids}} }
74+
\seealso{ \code{\link{activity.attribute}}, \code{\link{activate}}, \code{\link[network]{valid.eids}} }
7575
\examples{
7676
triangle <- network.initialize(3) # create a toy network
7777
add.edge(triangle,1,2) # add an edge between vertices 1 and 2

man/network.extensions.Rd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
%- Also NEED an '\alias' for EACH other topic documented here.
2121
\title{ Dynamically Extended Core Network Functions }
2222
\description{
23-
Various core functions from the \link{network} package, with specialized extensions for handling dynamic data.
23+
Various core functions from the \link[network]{network} package, with specialized extensions for handling dynamic data.
2424
}
2525
\usage{
2626
get.edgeIDs.active(x, v, onset = NULL, terminus = NULL, length = NULL, at = NULL,

man/persistent_ids.Rd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The function \code{initialize.pids} can be used to create a set of pids on all e
5454

5555
The element addition functions (\code{add.vertices}) override their network-package counterparts in order to permit assigning pids to newly-added elements if the pid is defined. They can be defined by the user with the \code{vertex.pids} argument, or, if not specified, a unique random id will be generated. (Note that any new values added by default to a \code{vertex.names} pid will not be numeric.)
5656

57-
Some of the import/conversion methods may set pids. See \code{\link{network}}.
57+
Some of the import/conversion methods may set pids. See \code{\link[network]{network}}.
5858

5959
User-specified pids are checked for uniqueness. The the current auto-generated pid implementation produces ids that are unique within the current network. They are also \emph{almost} certain to be unique within an R session (so that vertices will have a unique id if added and removed) and quite likely across sessions, but we need more details on the \code{tempfile}'s implementation.
6060

man/print.networkDynamic.Rd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Only prints out the network information without any dynamic data.
4545
%% ~Make other sections like Warning with \section{Warning }{....} ~
4646
4747
\seealso{
48-
\code{\link{print.network}}
48+
\code{\link[network]{print.network}}
4949
}
5050
\examples{
5151
library(networkDynamic)

man/tea_functions.Rd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ Attribute activity is only checked against vertex and edge activity during fetch
220220

221221

222222
\seealso{
223-
See Also as \code{\link{set.vertex.attribute}}, \code{\link{get.vertex.attribute}},\code{\link{list.vertex.attributes}},\code{\link{activate.vertices}}, \code{\link{activity.attribute}}, \code{\link{activate}}
223+
See Also as \code{\link[network]{set.vertex.attribute}}, \code{\link[network]{get.vertex.attribute}},\code{\link[network]{list.vertex.attributes}},\code{\link{activate.vertices}}, \code{\link{activity.attribute}}, \code{\link{activate}}
224224
}
225225
\examples{
226226
#initialize network

0 commit comments

Comments
 (0)