Skip to content

Commit

Permalink
Updating documentation and preparing for release
Browse files Browse the repository at this point in the history
  • Loading branch information
gvegayon committed May 20, 2021
1 parent 08ed840 commit a15928b
Show file tree
Hide file tree
Showing 10 changed files with 11 additions and 10 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 36,4 @@ makefile
^_pkgdown\.yml$
^netdiffuseR\.tar\.gz$
^\.github
netdiffuseR\.Rcheck
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 52,7 @@ LinkingTo: Rcpp, RcppArmadillo
RoxygenNote: 7.1.1
Encoding: UTF-8
URL: https://github.com/USCCANA/netdiffuseR,
https://USCCANA.github.io/netdiffuseR
https://USCCANA.github.io/netdiffuseR/
BugReports: https://github.com/USCCANA/netdiffuseR/issues
Classification/MSC: 90C35, 90B18, 91D30
Collate:
Expand Down
2 changes: 1 addition & 1 deletion R/RcppExports.R
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 209,7 @@ rgraph_er_cpp <- function(n = 10L, p = 0.3, undirected = TRUE, weighted = FALSE,
#' @return A sparse matrix of class \code{\link[Matrix:dgCMatrix-class]{dgCMatrix}} of size
#' \eqn{n\times n}{n * n}.
#' @references Watts, D. J., & Strogatz, S. H. (1998). Collective dynamics of
#' “small-world” networks. Nature, 393(6684), 440–2. \url{http://doi.org/10.1038/30918}
#' “small-world” networks. Nature, 393(6684), 440–2. \doi{10.1038/30918}
#' @export
#' @family simulation functions
ring_lattice <- function(n, k, undirected = FALSE) {
Expand Down
2 changes: 1 addition & 1 deletion R/random_graph.R
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 23,7 @@
#' networks are uncorrelated.
#' @references
#' Barabasi, Albert-Laszlo. "Network science book" Retrieved November 1 (2015)
#' \url{http://barabasi.com/book/network-science}.
#' \url{https://barabasi.com/book/network-science}.
#' @return A graph represented by an adjacency matrix (if \code{t=1}), or an array of
#' adjacency matrices (if \code{t>1}).
#' @export
Expand Down
4 changes: 2 additions & 2 deletions R/rewire.r
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 134,7 @@
#' Milo, R., Kashtan, N., Itzkovitz, S., Newman, M. E. J., & Alon, U.
#' (2004). On the uniform generation of random graphs with prescribed degree sequences.
#' Arxiv Preprint condmat0312028, cond-mat/0, 1–4. Retrieved from
#' \url{http://arxiv.org/abs/cond-mat/0312028}
#' \url{https://arxiv.org/abs/cond-mat/0312028}
#'
#' Ray, J., Pinar, A., and Seshadhri, C. (2012).
#' Are we there yet? When to stop a Markov chain while generating random graphs.
Expand Down Expand Up @@ -358,7 358,7 @@ rewire_graph.array <-function(graph, p, algorithm, both.ends, self, multiple, un
#'
#' Mantel, N. (1967). The detection of disease clustering and a generalized
#' regression approach. Cancer Research, 27(2), 209–20.
#' \url{http://cancerres.aacrjournals.org/content/27/2_Part_1/209}
#' \url{https://cancerres.aacrjournals.org/content/27/2_Part_1/209}
#'
#' @seealso This function can be used as null distribution in \code{struct_test}
#' @family simulation functions
Expand Down
2 changes: 1 addition & 1 deletion man/permute_graph.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/rewire_graph.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/rgraph_er.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/ring_lattice.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/rgraph.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 83,7 @@ arma::sp_mat rgraph_er_cpp(
//' @return A sparse matrix of class \code{\link[Matrix:dgCMatrix-class]{dgCMatrix}} of size
//' \eqn{n\times n}{n * n}.
//' @references Watts, D. J., & Strogatz, S. H. (1998). Collective dynamics of
//' “small-world” networks. Nature, 393(6684), 440–2. \url{http://doi.org/10.1038/30918}
//' “small-world” networks. Nature, 393(6684), 440–2. \doi{10.1038/30918}
//' @export
//' @family simulation functions
// [[Rcpp::export]]
Expand Down

0 comments on commit a15928b

Please sign in to comment.