Skip to content

Commit

Permalink
Remove links to cicero since it causes problems when not installed
Browse files Browse the repository at this point in the history
  • Loading branch information
timoast committed Nov 6, 2020
1 parent a7e141c commit 87da376
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
9 changes: 6 additions & 3 deletions R/links.R
Original file line number Diff line number Diff line change
Expand Up @@ -62,17 +62,20 @@ GetLinkedGenes <- function(
#' the start and end coordinates of the range are the midpoints of the linked
#' elements. Only elements on the same chromosome are included in the output.
#'
#' See the Cicero package for more information:
#' \url{https://bioconductor.org/packages/cicero/}
#'
#' @param conns A dataframe containing co-accessible elements. This would
#' usually be the output of \code{\link[cicero]{run_cicero}} or
#' \code{\link[cicero]{assemble_connections}}. Specifically, this should be a
#' usually be the output of \code{run_cicero} or
#' \code{assemble_connections}. Specifically, this should be a
#' dataframe where the first column contains the genomic coordinates of the
#' first element in the linked pair of elements, with chromosome, start, end
#' coordinates separated by "-" characters. The second column should be the
#' second element in the linked pair, formatted in the same way as the first
#' column. A third column should contain the co-accessibility scores.
#' @param ccans This is optional, but if supplied should be a dataframe
#' containing the cis-co-accessibility network (CCAN) information generated
#' by \code{\link[cicero]{generate_ccans}}. Specifically, this should be a
#' by \code{generate_ccans}. Specifically, this should be a
#' dataframe containing the name of the peak in the first column, and the
#' CCAN that it belongs to in the second column.
#' @param threshold Threshold for retaining a coaccessible site. Links with
Expand Down
10 changes: 7 additions & 3 deletions man/ConnectionsToLinks.Rd

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

0 comments on commit 87da376

Please sign in to comment.