From 9c90d5d9ff02c704101bb7a69d269ba55bd7d58e Mon Sep 17 00:00:00 2001 From: Andrea Manica Date: Thu, 17 Oct 2024 14:01:04 +0100 Subject: [PATCH] typo --- .Rbuildignore | 1 + R/q_matrix.R | 2 +- _pkgdown.yml | 4 ++-- man/tidy.q_matrix.Rd | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.Rbuildignore b/.Rbuildignore index 36411269..121042f3 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -4,3 +4,4 @@ ^LICENSE\.md$ ^\.github$ pkgdown/ +_pkgdown.yml diff --git a/R/q_matrix.R b/R/q_matrix.R index 7daefc54..ad78c094 100644 --- a/R/q_matrix.R +++ b/R/q_matrix.R @@ -64,7 +64,7 @@ q_matrix <- function(x) { #' #' Takes a `q_matrix` object, which is a matrix, and returns a tidied tibble. #' -#' @param x A Q matrix object (as returned by ['q_matrix']). +#' @param x A Q matrix object (as returned by [`q_matrix`]). #' @param data An associated tibble (e.g. a [`gen_tibble`]), with the individuals in the same order as the data used to #' generate the Q matrix #' @param ... not currently used diff --git a/_pkgdown.yml b/_pkgdown.yml index 7be658c2..8d7f4cd2 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -89,7 +89,7 @@ reference: - augment.gt_dapc - autoplot.gt_dapc - autoplot.gt_cluster_pca - - title: "K-clustering" + - title: "K-clustering (e.g. ADMXITURE)" desc: "Functions for creating, tidying, and visualising q_matrix objects." contents: - q_matrix @@ -100,7 +100,7 @@ reference: - distruct_colours - scale_fill_distruct - theme_distruct - - title: "Other analyses" + - title: "Other analyses (e.g. ADMIXTOOLS2, pcadapt)" desc: "Functions for other analyses within R." contents: - gt_extract_f2 diff --git a/man/tidy.q_matrix.Rd b/man/tidy.q_matrix.Rd index b83ea672..a8765353 100644 --- a/man/tidy.q_matrix.Rd +++ b/man/tidy.q_matrix.Rd @@ -7,7 +7,7 @@ \method{tidy}{q_matrix}(x, data, ...) } \arguments{ -\item{x}{A Q matrix object (as returned by \link{'q_matrix'}).} +\item{x}{A Q matrix object (as returned by \code{\link{q_matrix}}).} \item{data}{An associated tibble (e.g. a \code{\link{gen_tibble}}), with the individuals in the same order as the data used to generate the Q matrix}