Skip to content

Commit bba8f3d

Browse files
committed
R-devel does not permit linking to object, only to file. Breaks roxygen linking mechanism. (may be patched in future roxygen).
1 parent f98ebc9 commit bba8f3d

10 files changed

+54
-54
lines changed

CRAN-RELEASE

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
This package was submitted to CRAN on 2020-05-10.
2-
Once it is accepted, delete this file and tag the release (commit 5ccba746f0).
1+
This package was submitted to CRAN on 2020-06-11.
2+
Once it is accepted, delete this file and tag the release (commit f98ebc9c27).

DESCRIPTION

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Package: RNeXML
22
Type: Package
33
Title: Semantically Rich I/O for the 'NeXML' Format
4-
Version: 2.4.4
4+
Version: 2.4.5
55
Authors@R: c(person("Carl", "Boettiger", role = c("cre", "aut"),
66
email="[email protected]", comment = c(ORCID="0000-0002-1642-628X")),
77
person("Scott", "Chamberlain", role ="aut", comment = c(ORCID="0000-0003-1444-9135")),
@@ -86,7 +86,7 @@ Collate:
8686
'tbl_df.R'
8787
'utils.R'
8888
Roxygen: list(markdown = TRUE)
89-
RoxygenNote: 7.1.0
89+
RoxygenNote: 7.1.0.9000
9090
X-schema.org-applicationCategory: Data Publication
9191
X-schema.org-keywords: metadata, nexml, phylogenetics, linked-data
9292
X-schema.org-isPartOf: https://ropensci.org

R/S4-utils.R

+23-23
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
#' Finds the method that callNextMethod() should chain to
44
#'
55
#' Attempts to find the "next" method in the inheritance chain. This would
6-
#' (ideally) be the method that [methods::callNextMethod()] would chain to,
7-
#' as a result of the method [methods::addNextMethod()] would find (and return
8-
#' in the `nextMethod` slot of the [MethodWithNext][methods::MethodWithNext-class]
6+
#' (ideally) be the method that `methods::callNextMethod()` would chain to,
7+
#' as a result of the method `methods::addNextMethod()` would find (and return
8+
#' in the `nextMethod` slot of the `MethodWithNext`
99
#' object). Hence, in theory one shouldn't ever need this, but unfortunately
1010
#' `addNextMethod()` is broken (and errors out) if one of the classes in the
1111
#' signature name-clashes with an S4 class defined in another package that is
@@ -16,18 +16,18 @@
1616
#' the signature that are defined in the package of the generic method from
1717
#' which this function was invoked (directly or indirectly). If there are
1818
#' no such parameters in the signature, or if there is more than one,
19-
#' finding the next method is handed off to [methods::addNextMethod()].
19+
#' finding the next method is handed off to `methods::addNextMethod()`.
2020
#' @note In theory a class name clash between packages shouldn't be a problem
21-
#' because class names can be namespaced, and the [MethodDefinition][methods::MethodDefinition-class]
21+
#' because class names can be namespaced, and the `MethodDefinition`
2222
#' object passed to `addNextMethod()` has all the necessary namespace
2323
#' information. Hopefully, at some point this gets fixed in R, and then we
2424
#' don't need this anymore.
25-
#' @param method [MethodDefinition][methods::MethodDefinition-class]), the method for which to find
25+
#' @param method `MethodDefinition`, the method for which to find
2626
#' the next method
27-
#' @param f [standardGeneric][methods::standardGeneric-class], the standard generic for which to find
27+
#' @param f `standardGeneric`, the standard generic for which to find
2828
#' the next method. By default this will be obtained from `method`.
2929
#' @param envir the environment in which to find the method
30-
#' @return a [MethodDefinition][methods::MethodDefinition-class] object that is the next method in the
30+
#' @return a `MethodDefinition` object that is the next method in the
3131
#' chain by inheritance
3232
#' @importFrom methods getClassDef selectMethod addNextMethod
3333
#' @importFrom utils packageName
@@ -74,17 +74,17 @@ findNextMethod <- function(method, f = NULL, envir = topenv()) {
7474
#' Saves the next method in the method meta data
7575
#'
7676
#' Promotes the given method definition to an instance of
77-
#' [MethodWithNext][methods::MethodWithNext-class], thereby recording the next
77+
#' `MethodWithNext`, thereby recording the next
7878
#' method in the `nextMethod` slot.
7979
#' @note `MethodWithNext` objects are normally returned by
80-
#' [methods::addNextMethod()], but a constructor function for the class
80+
#' `methods::addNextMethod()`, but a constructor function for the class
8181
#' seems missing (or is undocumented?). This provides one.
82-
#' @param method the [MethodDefinition][methods::MethodDefinition-class] object to promote
83-
#' @param nextMethod the [MethodDefinition][methods::MethodDefinition-class]
82+
#' @param method the `MethodDefinition` object to promote
83+
#' @param nextMethod the `MethodDefinition`
8484
#' object to record as the next method
8585
#' @param .cache whether to cache the promoted method definition object
86-
#' (using [methods::cacheMethod()])
87-
#' @return an instance of [MethodWithNext][methods::MethodWithNext-class],
86+
#' (using `methods::cacheMethod()`)
87+
#' @return an instance of `MethodWithNext`,
8888
#' which has the next method in the `nextMethod` slot
8989
#' @importFrom methods getGeneric cacheMethod
9090
#' @importClassesFrom methods MethodWithNext
@@ -108,9 +108,9 @@ findNextMethod <- function(method, f = NULL, envir = topenv()) {
108108
#' Creates a label for a signature mirroring the result of `.sigLabel()`
109109
#' in the `methods` package, which unfortunately does not export the function.
110110
#' This is needed, for example, for the `excluded` slot in the
111-
#' [MethodWithNext][methods::MethodWithNext-class] class.
111+
#' `MethodWithNext` class.
112112
#' @param signature the signature for which to create a label, as a vector
113-
#' or list of strings, or as an instance of [signature][methods::signature-class].
113+
#' or list of strings, or as an instance of `signature`.
114114
#' @return a character string
115115
.sigLabel <- function(signature) {
116116
if (is(signature, "signature")) signature <- signature@.Data
@@ -121,13 +121,13 @@ findNextMethod <- function(method, f = NULL, envir = topenv()) {
121121
#'
122122
#' If the calling environment does not have the next method to be invoked
123123
#' in the inheritance chain cached yet, this will find the next method
124-
#' (using [findNextMethod()]), and cache it in the calling environment such
125-
#' that a subsequent call to [methods::callNextMethod()] will find and use
124+
#' (using `findNextMethod()`, and cache it in the calling environment such
125+
#' that a subsequent call to `methods::callNextMethod()` will find and use
126126
#' it.
127127
#'
128128
#' As per the description, what this function does would normally already
129-
#' be done by invoking [methods::callNextMethod()], so in theory this should
130-
#' be entirely redundant at best. However, [methods::addNextMethod()], which
129+
#' be done by invoking `methods::callNextMethod()`, so in theory this should
130+
#' be entirely redundant at best. However, `methods::addNextMethod()`, which
131131
#' is invoked by `callNextMethod()` if a next method isn't cached yet, is
132132
#' broken (errors out) if one of the classes in the signature name-clashes
133133
#' with a class defined in another package. Calling this function prior to
@@ -162,15 +162,15 @@ findNextMethod <- function(method, f = NULL, envir = topenv()) {
162162
#' Calls the given generic with the given arguments, using the method
163163
#' whose signature matches the arguments.
164164
#'
165-
#' Uses [methods::selectMethod()] to find the matching method. In theory,
165+
#' Uses `methods::selectMethod()` to find the matching method. In theory,
166166
#' this is at best wholly redundant with what standard S4 generics already
167167
#' do by themselves. However, the generics dispatch for S4 seems (at least
168168
#' currently) broken at least if the first argument in the signature is
169169
#' a class that name-clashes with a class defined in another package. In
170170
#' that case, whether the standard dispatch works correctly or not can depend
171-
#' on [search order][base::search()], and can change within a session
171+
#' on `search()` order, and can change within a session
172172
#' depending on the order in which packages are loaded.
173-
#' @param f the generic, as a character string or a [standardGeneric][methods::standardGeneric-class]
173+
#' @param f the generic, as a character string or a `standardGeneric`
174174
#' object
175175
#' @param ... the arguments (named and/or unnamed) with which to call the
176176
#' matching method

R/nexml_read.R

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#' Read NeXML files into various R formats
22
#'
3-
#' @param x Path to the file to be read in. Or an \code{\link[XML]{XMLInternalDocument-class}}
4-
#' or \code{\link[XML]{XMLInternalNode-class}}
3+
#' @param x Path to the file to be read in. Or an \code{\link[XML]{XMLDocument-class}}
4+
#' or \code{\link[XML]{XMLNode-class}}
55
#' @param ... Further arguments passed on to \code{\link[XML]{xmlParse}}
66
#' @import XML
77
#' @import httr

man/dot-cacheNextMethod.Rd

+4-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/dot-callGeneric.Rd

+3-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/dot-methodWithNext.Rd

+6-6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/dot-sigLabel.Rd

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/findNextMethod.Rd

+8-8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/nexml_read.Rd

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)