Skip to content

Commit

Permalink
docs: update help pages
Browse files Browse the repository at this point in the history
  • Loading branch information
stefpeschel committed Oct 31, 2024
1 parent f710643 commit ba3a917
Show file tree
Hide file tree
Showing 13 changed files with 175 additions and 89 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Imports:
WGCNA
Remotes:
bioc::Biobase,
bioc::metagenomeSeq,
bioc::metagenomeSeq@1.47.0,
bioc::phyloseq,
github::zdk123/SpiecEasi,
github::GraceYoon/SPRING,
Expand Down
6 changes: 3 additions & 3 deletions R/calcGCD.R
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@
#'
#' @details
#' By default, only the 11 non-redundant orbits are used. These are grouped
#' according to their role: orbit 0 represents the degree, orbits {2, 5, 7}
#' represent nodes within a chain, orbits {8, 10, 11} represent nodes in a
#' cycle, and orbits {6, 9, 4, 1} represent a terminal node.
#' according to their role: orbit 0 represents the degree, orbits (2, 5, 7)
#' represent nodes within a chain, orbits (8, 10, 11) represent nodes in a
#' cycle, and orbits (6, 9, 4, 1) represent a terminal node.
#'
#' @return An object of class \code{gcd} containing the following elements:
#' \tabular{ll}{
Expand Down
6 changes: 3 additions & 3 deletions R/calcGCM.R
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@
#'
#' @details
#' By default, only the 11 non-redundant orbits are used. These are grouped
#' according to their role: orbit 0 represents the degree, orbits {2, 5, 7}
#' represent nodes within a chain, orbits {8, 10, 11} represent nodes in a
#' cycle, and orbits {6, 9, 4, 1} represent a terminal node.
#' according to their role: orbit 0 represents the degree, orbits (2, 5, 7)
#' represent nodes within a chain, orbits (8, 10, 11) represent nodes in a
#' cycle, and orbits (6, 9, 4, 1) represent a terminal node.
#'
#' @return A list with the following elements:
#' \tabular{ll}{
Expand Down
6 changes: 3 additions & 3 deletions R/netAnalyze.R
Original file line number Diff line number Diff line change
Expand Up @@ -147,9 +147,9 @@
#' (Yaveroglu et al., 2014).}
#' }
#' By default, only the 11 non-redundant orbits are used. These are grouped
#' according to their role: orbit 0 represents the degree, orbits {2, 5, 7}
#' represent nodes within a chain, orbits {8, 10, 11} represent nodes in a
#' cycle, and orbits {6, 9, 4, 1} represent a terminal node.
#' according to their role: orbit 0 represents the degree, orbits (2, 5, 7)
#' represent nodes within a chain, orbits (8, 10, 11) represent nodes in a
#' cycle, and orbits (6, 9, 4, 1) represent a terminal node.
#'
#' @param net object of class \code{microNet} (returned by
#' \code{\link{netConstruct}}).
Expand Down
2 changes: 1 addition & 1 deletion R/plot.diffNet.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
#' a character with one of the layouts provided by
#' \code{\link[qgraph]{qgraph}}: \code{"spring"}(default), \code{"circle"},
#' or \code{"groups"}. Alternatively, the layouts provided by igraph (see
#' \code{\link[igraph:layout_]{layout\_}}) are accepted (must be given as
#' \code{\link[igraph:layout_]{layout_}}) are accepted (must be given as
#' character, e.g. \code{"layout_with_fr"}). Can also be a matrix with row
#' number equal to the number of nodes and two columns corresponding to the x
#' and y coordinate.
Expand Down
2 changes: 1 addition & 1 deletion R/plot.microNetProps.R
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
#' a character with one of the layouts provided by
#' \code{\link[qgraph]{qgraph}}: \code{"spring"} (default), \code{"circle"},
#' or \code{"groups"}. Alternatively, the layouts provided by igraph (see
#' \code{\link[igraph:layout_]{layout\_}} are accepted (must be given as
#' \code{\link[igraph:layout_]{layout_}} are accepted (must be given as
#' character, e.g. \code{"layout_with_fr"}). Can also be a matrix with row
#' number equal to the number of nodes and two columns corresponding to the x
#' and y coordinate.
Expand Down
6 changes: 3 additions & 3 deletions man/calcGCD.Rd

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

6 changes: 3 additions & 3 deletions man/calcGCM.Rd

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

6 changes: 3 additions & 3 deletions man/netAnalyze.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/plot.diffnet.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/plot.microNetProps.Rd

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

Loading

0 comments on commit ba3a917

Please sign in to comment.