Re: [R] Packaging - Function with dots as argument
Hello,
You can put that in the Details section, something like
\arguments{
\item{\dots}{several arguments to pass to another function, see
Details}
}
and then document the arguments a and b in the Details section.
Hope this helps,
Rui Barradas
Em 26-01-2014 01:45, Eva Prieto Castro escreveu:
Hi everybody,
I am writing the .Rd files of my pckage, and I have a doubt in relation with
the Rd file of a function that has dots as unique argument.
I mean the following:
g <- function(a,b) a + b
f <- function( ... ) g(...)
Imagine I have the Rd file of "f" function. The "usage" is as follows:
\usage{
f(...)
}
The arguments zone is as follows:
\arguments{
\item{\dots}{several arguments to pass to another function}
}
Here is my doubt: If I want to detail de arguments "a" and "b" in the Rd file of the "f" function, how can I do it?. What "tag"
and zone in the Rd file have I to use?. I am asking this because "g" function is not a visible function in package, so I must describe "a" and
"b" in Rd file of "f" function (I can not ask the user for reading the "g" function Rd).
I hope I have told you the idea in the best way.
Thank you in advance.
Eva
[[alternative HTML version deleted]]
__
R-help@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.
__
R-help@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.
Re: [R] Packaging - Function with dots as argument
Hi again,
I have chosen the solution reading the Rd file of xyplot.zoo function, in zoo
package.
Regards.
Eva
El Domingo 26 de enero de 2014 2:45, Eva Prieto Castro
escribió:
Hi everybody,
I am writing the .Rd files of my pckage, and I have a doubt in relation with
the Rd file of a function that has dots as unique argument.
I mean the following:
g <- function(a,b) a + b
f <- function( ... ) g(...)
Imagine I have the Rd file of "f" function. The "usage" is as follows:
\usage{
f(...)
}
The arguments zone is as follows:
\arguments{
\item{\dots}{several arguments to pass to another function}
}
Here is my doubt: If I want to detail de arguments "a" and "b" in the Rd file
of the "f" function, how can I do it?. What "tag" and zone in the Rd file have
I to use?. I am asking this because "g" function is not a visible function in
package, so I must describe "a" and "b" in Rd file of "f" function (I can not
ask the user for reading the "g" function Rd).
I hope I have told you the idea in the best way.
Thank you in advance.
Eva
[[alternative HTML version deleted]]
__
R-help@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.
[R] Packaging - Function with dots as argument
Hi everybody,
I am writing the .Rd files of my pckage, and I have a doubt in relation with
the Rd file of a function that has dots as unique argument.
I mean the following:
g <- function(a,b) a + b
f <- function( ... ) g(...)
Imagine I have the Rd file of "f" function. The "usage" is as follows:
\usage{
f(...)
}
The arguments zone is as follows:
\arguments{
\item{\dots}{several arguments to pass to another function}
}
Here is my doubt: If I want to detail de arguments "a" and "b" in the Rd file
of the "f" function, how can I do it?. What "tag" and zone in the Rd file have
I to use?. I am asking this because "g" function is not a visible function in
package, so I must describe "a" and "b" in Rd file of "f" function (I can not
ask the user for reading the "g" function Rd).
I hope I have told you the idea in the best way.
Thank you in advance.
Eva
[[alternative HTML version deleted]]
__
R-help@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.
