Skip to content

Commit

Permalink
reversion to dontrun
Browse files Browse the repository at this point in the history
Without prepared data objects in sysdata.rda, donttest examples produce an error. dontrun code will be kept in place until the test data is implemented.
  • Loading branch information
jmitchell81 committed Dec 14, 2023
1 parent 8ddf040 commit fed94ef
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
6 changes: 3 additions & 3 deletions R/differential_fxns.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ NULL
#' @return A linkage summary class object consisting of nested lists of the active transcription factors, active receptors, and incoming ligands for each cluster across multiple domino results.
#' @export
#' @examples
#' \donttest{
#' \dontrun{
#' meta_df <- data.frame("ID" = c("P1", "P2"), "group" = c("A", "B"))
#' dom_ls <- list("P1" = dom1, "P2" = dom2)
#' summarize_linkages(
Expand Down Expand Up @@ -108,7 +108,7 @@ summarize_linkages <- function(domino_results, subject_meta, subject_names = NUL
#' @return a data frame with columns for the unique linkage features and the counts of how many times the linkage occured across the compared domino results. If group.by is used, counts of the linkages are also provided as columns named by the unique values of the group.by variable.
#' @export
#' @examples
#' \donttest{
#' \dontrun{
#' count_linkage(linkage_summary = linkage_ls, cluster = "CD8_T_cell",
#' group.by = "group", linkage = "rec_lig")
#' }
Expand Down Expand Up @@ -170,7 +170,7 @@ count_linkage <- function(linkage_summary, cluster, group.by = NULL, linkage = "
#' }
#' @export
#' @examples
#' \donttest{
#' \dontrun{
#' test_differential_linkages(linkage_summary = linkage_ls, cluster = "CD8_T_cell",
#' group.by = "group", linkage = "rec_lig", test_name = "fishers.exact")
#' }
Expand Down
2 changes: 1 addition & 1 deletion R/plot_fxns.R
Original file line number Diff line number Diff line change
Expand Up @@ -870,7 +870,7 @@ circos_ligand_receptor <- function(
#' @return a Heatmap-class object of features ranked by test_statistic annotated with the proportion of subjects that showed active linkage of the features.
#' @export
#' @examples
#' \donttest{
#' \dontrun{
#' plot_differential_linkages(
#' differential_linkages = diff_linkages_tiny,
#' test_statistic = "p.value",
Expand Down
6 changes: 4 additions & 2 deletions R/processing_fxns.R
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@
#' @return A domino object with a signaling network built
#' @export
#' @examples
#' pbmc_dom_tiny_built <- build_domino(dom = domino2:::pbmc_dom_tiny, min_tf_pval = .001, max_tf_per_clust = 25,
#' max_rec_per_tf = 25, rec_tf_cor_threshold = .25, min_rec_percentage = 0.1)
#' pbmc_dom_tiny_built <- build_domino(
#' dom = domino2:::pbmc_dom_tiny, min_tf_pval = .001, max_tf_per_clust = 25,
#' max_rec_per_tf = 25, rec_tf_cor_threshold = .25, min_rec_percentage = 0.1
#' )
#'
build_domino <- function(
dom, max_tf_per_clust = 5, min_tf_pval = 0.01, max_rec_per_tf = 5, rec_tf_cor_threshold = 0.15,
Expand Down

0 comments on commit fed94ef

Please sign in to comment.