Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.11.4 release candiate to correct Doc fixes and C warnings flagged by CRAN in #21 #23

Merged
merged 9 commits into from
Dec 10, 2023
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: networkDynamic
Version: 0.11.3
Date: 2023-02-15
Version: 0.11.4
Date: 2023-12-08
Title: Dynamic Extensions for Network Objects
Type: Package
Depends: R (>= 3.0.0), network (>= 1.17.0)
Expand Down
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ S3method(as.networkDynamic,network)
S3method(as.networkDynamic,networkDynamic)
S3method(print,networkDynamic)
S3method(as.networkDynamic,networkLite)
S3method(as.networkDynamic,siena)

# these are NOT S3 methods, but are included here because its the
# only way to quiet the warning
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This package is a part of the [Statnet](https://statnet.org) suite of packages f

## Docs and Examples

`networkDynamic` [package vignette](https://cran.r-project.org/web/packages/networkDynamic/vignettes/networkDynamic.pdf)
`networkDynamic` [package vignette](https://CRAN.R-project.org/package=networkDynamic/vignettes/networkDynamic.pdf) [reference manual](https://CRAN.R-project.org/package=networkDynamic/networkDynamic.pdf)

Tutorials on using `networkDynamic` in data analysis workflows include the Statnet workshops [Temporal network tools in statnet: networkDynamic, ndtv and tsna](https://statnet.org/workshop-ndtv/ndtv_workshop.html) [Temporal Exponential Random Graph Models (TERGMs) for dynamic networks](https://statnet.org/workshop-tergm/)

Expand Down
12 changes: 6 additions & 6 deletions man/activity.attribute.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,20 @@
They must be consecutive, ordered forward in time, and strictly
non-overlapping.

The syntax for defining or querying spells can specify either an instantaneous time point or an interval. The commands for this include \code{at=}, \code{onset=}, \code{terminus=} and \code{length=}. Any numeric values may be used in the interval specifications, including \code{Inf} and \code{-Inf}, (with some restrictions, see below). A spell with \code{onset=-Inf} represents onset censoring. A spell with \code{terminus=Inf} represents terminus censoring. \code{Inf} and \code{-Inf} cannot be used with the \code{at} specification. Similarly, \code{onset} can not be \code{Inf} and \code{terminus} can not be {-Inf}.
The syntax for defining or querying spells can specify either an instantaneous time point or an interval. The commands for this include \code{at=}, \code{onset=}, \code{terminus=} and \code{length=}. Any numeric values may be used in the interval specifications, including \code{Inf} and \code{-Inf}, (with some restrictions, see below). A spell with \code{onset=-Inf} represents onset censoring. A spell with \code{terminus=Inf} represents terminus censoring. \code{Inf} and \code{-Inf} cannot be used with the \code{at} specification. Similarly, \code{onset} can not be \code{Inf} and \code{terminus} can not be \code{-Inf}.

The general syntax rules for specifying spells are as follows:

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
5 changes: 3 additions & 2 deletions man/networkDynamic-package.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Additional example data sets can be found in the \code{networkDynamicData} packa
\author{
Originally created by Carter T. Butts \email{buttsc@uci.edu},

Current Maintainer: Skye Bender-deMoll {skyebend@uw.edu}
Current Maintainer: Skye Bender-deMoll \email{skyebend@uw.edu}

Contributions from:
Pavel Krivitsky \email{pavel@uow.edu.au},
Expand All @@ -47,7 +47,8 @@ Kirk Li \email{kirkli@uw.edu},
StevenGoodreau \email{goodreau@uw.edu},
Zack Almquist \email{almquist@uci.edu},
Jeffrey Horner \email{jeffrey.horner@gmail.com},
Martina Morris \email{morrism@u.washington.edu}
Martina Morris \email{morrism@u.washington.edu},
Michal Bojanowski \email{michal2992@gmail.com}

With support from the statnet team \url{https://statnet.org}

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
2 changes: 1 addition & 1 deletion src/wtedgetree.c
Original file line number Diff line number Diff line change
Expand Up @@ -625,7 +625,7 @@ void Wtprintedge(Edge e, WtTreeNode *edges){
Rprintf("\t.parent=%d\n",edges[e].parent);
Rprintf("\t.left=%d\n",edges[e].left);
Rprintf("\t.right=%d\n",edges[e].right);
Rprintf("\t.weight=%d\n",edges[e].weight);
Rprintf("\t.weight=%f\n",edges[e].weight);
}

/*****************
Expand Down