StackOverflow2013

Note that there are some explanatory texts on larger screens.

plurals

POHow to specify in which order to load S4 methods when using roxygen2
text
Body
copied!<p>I ran into following problem already multiple times.</p> <p>Say you have two classes, <code>classA</code> and <code>classB</code> described in the following files <code>classA.R</code> :</p> <pre><code>#' the class classA #' #' This is a class A blabla #' \section{Slots}{\describe{\item{\code{A}}{a Character}}} #' @ name classA #' @rdname classA #' @exportClass classA setClass("classA",representation(A="character")) </code></pre> <p>And <code>classB.R</code></p> <pre><code>#' the class classB #' #' This is a class B blabla #' \section{Slots}{\describe{\item{\code{B}}{an object of class A}}} #' @ name classB #' @rdname classB #' @exportClass classB setClass("classB",representation(B="classA")) </code></pre> <p>I believed these files were read in alphabetical order by <code>roxygen2</code>, but that is not the case. If I try to build the package, I might get the following error:</p> <pre><code>roxygenize("./myExample") Error in getClass(Class, where = topenv(parent.frame())) : "ClassA" is not a defined class </code></pre> <p>How can I make sure that <code>roxygenize()</code> knows in which order to read the files, i.e. which class definition should be read before the other?</p> <hr> <p>Note : I know I answered my own question. That is because I ran into this problem rather often, and realized the proper way to do this after looking at the code of <code>roxygen2</code>. So for reference, here's my findings. </p>

Querying!

Guidance

An individual column

Larger individual text columns get their own page to allow for proper reading.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload