Skip to content

Commit 10cdda4

Browse files
Update ccdr.run docs to include sigmas
1 parent 6bbafda commit 10cdda4

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

R/ccdrAlgorithm-main.R

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,11 @@ NULL
6060
#' current DAG estimate is \code{> alpha * ncol(data)}.
6161
#' @param betas Initial guess for the algorithm. Represents the weighted adjacency matrix
6262
#' of a DAG where the algorithm will begin searching for an optimal structure.
63+
#' @param sigmas Numeric vector of known values of conditional variances for each node in the network. If this is
64+
#' set by the user, these parameters will not be computed and the input will
65+
#' be used as the "true" values of the variances in the algorithm. Note that setting
66+
#' this to be all ones (i.e. \code{sigmas[j] = 1} for all \code{j}) is
67+
#' equivalent to using the least-squares loss.
6368
#' @param verbose \code{TRUE / FALSE} whether or not to print out progress and summary reports.
6469
#'
6570
#' @return A \code{\link[sparsebnUtils]{sparsebnPath}} object.

man/ccdr.run.Rd

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)