Browse code

fix typo with Service-class roxygen doc

LiNk-NY authored on 10/12/2024 16:28:09
Showing 2 changed files

... ...
@@ -7,13 +7,13 @@
7 7
 #' @description The `cBioPortal` class is a representation of the `cBioPortal`
8 8
 #'     API protocol that directly inherits from the `Service` class in the
9 9
 #'     `AnVIL` package. For more information, see the
10
-#'     [AnVIL][AnVIL:Service-class] package.
10
+#'     [AnVIL][AnVIL::Service-class] package.
11 11
 #'
12 12
 #' @details This class takes the static API as provided at
13 13
 #'     <https://www.cbioportal.org/api/v2/api-docs> and creates an R object
14 14
 #'     with the help from underlying infrastructure (i.e.,
15 15
 #'     [rapiclient][rapiclient::rapiclient-package] and
16
-#'     [AnVIL][AnVIL:Service-class]) to give the user a unified representation
16
+#'     [AnVIL][AnVIL::Service-class]) to give the user a unified representation
17 17
 #'     of the API specification provided by the cBioPortal group. Users are not
18 18
 #'     expected to interact with this class other than to use it as input
19 19
 #'     to the functionality provided by the rest of the package.
... ...
@@ -22,7 +22,7 @@
22 22
 #'
23 23
 #' @return A `cBioPortal` class instance
24 24
 #'
25
-#' @seealso  [cBioPortal], [AnVIL][AnVIL:Service-class]
25
+#' @seealso  [cBioPortal], [AnVIL][AnVIL::Service-class]
26 26
 #'
27 27
 #' @examples
28 28
 #'
... ...
@@ -40,7 +40,7 @@
40 40
 #' @importFrom AnVIL operations
41 41
 #' @importFrom methods callNextMethod
42 42
 #'
43
-#' @param x A [AnVIL][AnVIL:Service-class] instance or API representation as
43
+#' @param x A [AnVIL][AnVIL::Service-class] instance or API representation as
44 44
 #'     given by the [cBioPortal] function.
45 45
 #'
46 46
 #' @inheritParams AnVIL::operations
... ...
@@ -10,7 +10,7 @@
10 10
 \S4method{operations}{cBioPortal}(x, ..., .deprecated = FALSE)
11 11
 }
12 12
 \arguments{
13
-\item{x}{A \link[=AnVIL:Service-class]{AnVIL} instance or API representation as
13
+\item{x}{A \link[AnVIL:Services]{AnVIL} instance or API representation as
14 14
 given by the \link{cBioPortal} function.}
15 15
 
16 16
 \item{...}{additional arguments passed to methods or, for
... ...
@@ -26,14 +26,14 @@ A \code{cBioPortal} class instance
26 26
 The \code{cBioPortal} class is a representation of the \code{cBioPortal}
27 27
 API protocol that directly inherits from the \code{Service} class in the
28 28
 \code{AnVIL} package. For more information, see the
29
-\link[=AnVIL:Service-class]{AnVIL} package.
29
+\link[AnVIL:Services]{AnVIL} package.
30 30
 }
31 31
 \details{
32 32
 This class takes the static API as provided at
33 33
 \url{https://www.cbioportal.org/api/v2/api-docs} and creates an R object
34 34
 with the help from underlying infrastructure (i.e.,
35 35
 \link[rapiclient:rapiclient-package]{rapiclient} and
36
-\link[=AnVIL:Service-class]{AnVIL}) to give the user a unified representation
36
+\link[AnVIL:Services]{AnVIL}) to give the user a unified representation
37 37
 of the API specification provided by the cBioPortal group. Users are not
38 38
 expected to interact with this class other than to use it as input
39 39
 to the functionality provided by the rest of the package.
... ...
@@ -49,5 +49,5 @@ cBioPortal()
49 49
 
50 50
 }
51 51
 \seealso{
52
-\link{cBioPortal}, \link[=AnVIL:Service-class]{AnVIL}
52
+\link{cBioPortal}, \link[AnVIL:Services]{AnVIL}
53 53
 }