Hi,
This actually is not about Rd format. Indeed, you are using 'roxygen' syntax.
Examples are not run when there is a good reason (long time, internet
connection required, specific local resources). This often means that the user
needs to be made aware that something is not as straightforwa
Hi there,
If I write a function with documentation (notice `\dontrun` section)
#' Print a string.
#'
#' @examples
#' \dontrun{
#' str_length(letters)
#'}
print_str <- function(str) {
print(string)
}
`roxygenize()` will create proper Rd file, however, `R CMD check .` will
generate:
```
...
## N
On 18 December 2017 at 13:12, Ralf Stubner wrote:
| On 18.12.2017 08:37, Baptiste Auguie wrote:
| > What I don't really understand (because of the templating system etc.) is
| > why this new routine in Armadillo would be needed at all, when cda does not
| > solve banded linear systems. I wonder if
On 18.12.2017 08:37, Baptiste Auguie wrote:
> What I don't really understand (because of the templating system etc.) is
> why this new routine in Armadillo would be needed at all, when cda does not
> solve banded linear systems. I wonder if a practical workaround would be to
> include a _dummy_ rou
Dear all,
I had realized that they were internal functions.
However, I was conjecturing that the maintainer intends for them to be employed
by package users and that use of the ':::' operator might be acceptable in
these circumstances.
It appears not and I have modified my package to remove a
And of course, you can even tell the Rd file that it documents an
internal function.
Best,
Uwe Ligges
On 18.12.2017 09:01, Uwe Ligges wrote:
On 18.12.2017 05:00, Dario Strbenac wrote:
Good day,
It seems that they are not internal functions if they are have user
documentation written for t
On 18.12.2017 05:00, Dario Strbenac wrote:
Good day,
It seems that they are not internal functions if they are have user
documentation written for them. Internal functions usually don't have a help
page.
You can document internal functions, why not?
The definition whether they are internal
