Skip to content

Commit 451b345

Browse files
mukamel-labanashen
authored andcommitted
Add link to vignette in docstring
1 parent c50c616 commit 451b345

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

R/generics.R

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,10 @@ FindClusters <- function(object, ...) {
101101

102102
#' Gene expression markers of identity classes
103103
#'
104-
#' Finds markers (differentially expressed genes) for each of the identity classes in a dataset. Note that differential expression between groups (e.g. treatment conditions) should be take into account biological variation across samples, e.g. by using pseudobulk expression profiles. See the vignette "Differential expression testing" for detailed discussion
104+
#' Finds markers (differentially expressed genes) for each of the identity classes in a dataset. Note that differential expression between groups (e.g. treatment conditions) should account for biological variation across samples, e.g. by using pseudobulk expression profiles.
105+
#' See the
106+
#' \code{\link[=vignette("de_vignette")]{Differential expression vignette}}
107+
#' for more examples.
105108
#'
106109
#' @param object An object
107110
#' @param ... Arguments passed to other methods and to specific DE methods
@@ -162,7 +165,10 @@ FindClusters <- function(object, ...) {
162165
#' @export FindMarkers
163166
#'
164167
#' @aliases FindMarkersNode
165-
#' @seealso \code{FoldChange}
168+
#' @seealso
169+
#' \link[=vignette("de_vignette")]{Differential expression vignette}
170+
#'
171+
#' \code{FoldChange}
166172
#'
167173
FindMarkers <- function(object, ...) {
168174
UseMethod(generic = 'FindMarkers', object = object)

0 commit comments

Comments
 (0)