From bd45fc12799f8de477189272e4343f0d59d85163 Mon Sep 17 00:00:00 2001 From: mpadge Date: Wed, 18 Sep 2024 13:10:05 +0200 Subject: [PATCH] inheritParams for similar_fns man entry --- DESCRIPTION | 2 +- R/similar-pkgs.R | 1 + codemeta.json | 2 +- man/pkgsimil_similar_fns.Rd | 3 +++ 4 files changed, 6 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 877b4e2..b12416e 100755 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: pkgsimil Title: Similarity Metrics between R Packages -Version: 0.1.1.059 +Version: 0.1.1.060 Authors@R: c( person("Mark", "Padgham", , "mark.padgham@email.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-2172-5265"))) diff --git a/R/similar-pkgs.R b/R/similar-pkgs.R index e30a688..56aad7e 100644 --- a/R/similar-pkgs.R +++ b/R/similar-pkgs.R @@ -59,6 +59,7 @@ similar_pkgs_from_pkg <- function (input, embeddings, n) { #' Use the embeddings from \link{pkgsimil_embeddings_raw} with `functions_only #' = TRUE` to identify functions best matching a given input string. #' +#' @inheritParams pkgsimil_similar_pkgs #' @param input A text string. #' @param embeddings A single matrix of embeddings produced from #' \link{pkgsimil_embeddings_raw} with `functions_only = TRUE`. diff --git a/codemeta.json b/codemeta.json index f5b16c0..61c908e 100644 --- a/codemeta.json +++ b/codemeta.json @@ -8,7 +8,7 @@ "codeRepository": "https://github.com/ropensci-review-tools/pkgsimil", "issueTracker": "https://github.com/ropensci-review-tools/pkgsimil/issues", "license": "https://spdx.org/licenses/MIT", - "version": "0.1.1.059", + "version": "0.1.1.060", "programmingLanguage": { "@type": "ComputerLanguage", "name": "R", diff --git a/man/pkgsimil_similar_fns.Rd b/man/pkgsimil_similar_fns.Rd index adf6978..39696d0 100644 --- a/man/pkgsimil_similar_fns.Rd +++ b/man/pkgsimil_similar_fns.Rd @@ -11,6 +11,9 @@ pkgsimil_similar_fns(input, embeddings, n = 5L) \item{embeddings}{A single matrix of embeddings produced from \link{pkgsimil_embeddings_raw} with \code{functions_only = TRUE}.} + +\item{n}{identify the \code{n} most similar packages in terms of both code and +text embeddings.} } \value{ A character vector of function names in the form