From a29409bd06e58330c85cecec527147bcac56b7a8 Mon Sep 17 00:00:00 2001 From: Gregory Jefferis Date: Sat, 25 May 2024 15:24:42 +0100 Subject: [PATCH] doc tweaks --- R/partners.R | 4 ++++ man/cf_partners.Rd | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/R/partners.R b/R/partners.R index 5e5aa49..57e8a55 100644 --- a/R/partners.R +++ b/R/partners.R @@ -1,5 +1,9 @@ #' Flexible function for fetching partner data across datasets #' +#' @details fancr and fafbseg functions have usually used a \code{>} +#' relationship for the threshold, but here (as of May 2024) it is uniformly a +#' \code{>=} relationship. +#' #' @param ids A list of ids named by the relevant datasets (see examples) or any #' other input that can be processed by the \code{\link{keys}} function #' (including a \code{hclust} dendrogram object.) diff --git a/man/cf_partners.Rd b/man/cf_partners.Rd index e8100b7..71a9cec 100644 --- a/man/cf_partners.Rd +++ b/man/cf_partners.Rd @@ -31,6 +31,11 @@ A data.frame or a named list (when \code{bind.rows=FALSE}) \description{ Flexible function for fetching partner data across datasets } +\details{ +fancr and fafbseg functions have usually used a \code{>} +relationship for the threshold, but here (as of May 2024) it is uniformly a +\code{>=} relationship. +} \examples{ \donttest{ da2ds=cf_partners(list(hemibrain='DA2_lPN'), threshold=5)