Skip to content

Commit

Permalink
attempting to fix .rd doc errors flagged by CRAN
Browse files Browse the repository at this point in the history
  • Loading branch information
skyebend committed Dec 8, 2023
1 parent fd9f91e commit 0c59215
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
10 changes: 5 additions & 5 deletions man/activity.attribute.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@

To specify a spell as a single time point:
\itemize{
\item use the \code{at} argument, or
\item use \code{onset=terminus}.
\item{ use the \code{at} argument, or}
\item{ use \code{onset=terminus}. }
}
To specify a spell as a particular interval, one of the following combinations of \code{onset}, \code{terminus} and \code{length} is required:
\itemize{
\item \code{onset} and \code{terminus}
\item \code{onset} and \code{length}
\item \code{terminus} and \code{length}
\item{ \code{onset} and \code{terminus} }
\item{ \code{onset} and \code{length} }
\item{ \code{terminus} and \code{length} }
}
The special \dQuote{null} spell is used to designate elements that are never active (i.e., have no valid activity spells). These can only be set by the \code{deactivate} function (see \code{\link{activity.attribute}}) and by convention are stored as \code{c(Inf,Inf)}. \dQuote{Null} spells are incompatible with other spells, and should be replaced whenever an activation enters the element's event history.
Expand Down
14 changes: 7 additions & 7 deletions man/network.dynamic.check.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -51,18 +51,18 @@ is.networkDynamic(x)
For \code{network.dynamic.check}: A list of logical vectors, one for
each network component checked:
\itemize{
\item{\code{$vertex.checks} : }{Whether the spell matrix of each vertex (if any)
\item{\code{$vertex.checks} : Whether the spell matrix of each vertex (if any)
is correctly specified}
\item{\code{$edge.checks} : }{Whether the spell matrix of each edge (if any)
\item{\code{$edge.checks} : Whether the spell matrix of each edge (if any)
is correctly specified}
\item{\code{$dyad.checks} : }{Corresponding to edges, whether the incident vertices
\item{\code{$dyad.checks} : Corresponding to edges, whether the incident vertices
of each edge are active when the edge is active}
\item{\code{$vertex.tea.checks} : }{Corresponding to vertices, whether the vertex has
\item{\code{$vertex.tea.checks} : Corresponding to vertices, whether the vertex has
correctly formed TEA attributes}
\item{\code{$edge.tea.checks} : }{Corresponding to edges, whether the edge has
\item{\code{$edge.tea.checks} : Corresponding to edges, whether the edge has
correctly formed TEA attributes}
\item{\code{$network.tea.checks} : }{Single boolean, whether the network TEA attributes are formed correctly}
\item{\code{$net.obs.period.check} : } {NULL, if no \code{net.obs.period} network attribute is present, otherwise a single boolean, whether the attribute is formed correctly. }
\item{\code{$network.tea.checks} : Single boolean, whether the network TEA attributes are formed correctly}
\item{\code{$net.obs.period.check} : NULL, if no \code{net.obs.period} network attribute is present, otherwise a single boolean, whether the attribute is formed correctly. }

}
For \code{is.networkDynamic}: a boolean which is true if the class matches
Expand Down
2 changes: 1 addition & 1 deletion man/print.networkDynamic.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Prints out some very basic descriptive stats about the network's dynamics, and t
\item{x}{ an object of class networkDynamic including dynamic relational information
}
\item{\dots}{
%% ~~Describe \code{\dots} here~~
additional items to be passed for consideration by other classes
}
}
\details{
Expand Down

0 comments on commit 0c59215

Please sign in to comment.