[Roxygen-devel] Templating mechanism?

[Johannes Graumann]

Hello,

Is there a ROxygen-integral mechanism for doc-type specific templating? What
I am looking for is a way in which I can define what ROxygen tags are
expected/required in a function, a class, a data set. If documentation
wouldn't comply to thosre rools there would be a warning at "document()"-
time ...

Thanks for your consideration.

Sincerely, Joh

[Hadley Wickham]

Hi Johannes,

I'm not sure what the purpose would be do - do you want some automated
way of ensuring that you've provided a predefined set of tags?

Hadley

On Sat, Dec 29, 2012 at 11:40 PM, Johannes Graumann

Post by Johannes Graumann
Hello,
Is there a ROxygen-integral mechanism for doc-type specific templating? What
I am looking for is a way in which I can define what ROxygen tags are
expected/required in a function, a class, a data set. If documentation
wouldn't comply to thosre rools there would be a warning at "document()"-
time ...
Thanks for your consideration.
Sincerely, Joh
_______________________________________________
Roxygen-devel mailing list
Roxygen-devel at lists.r-forge.r-project.org
https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/roxygen-devel

[Johannes Graumann]

Hello Hadley,

Exactly. Something like

In case the documented thing is a function we are
absolutely expecting (absence throws error):
@examples
@details
...
recomending (absence issues warning):
@seealso
...

In case the documented thing is a data set ...
etc.

Wouldn't that make sense?

Joh

Post by Hadley Wickham
Hi Johannes,
I'm not sure what the purpose would be do - do you want some automated
way of ensuring that you've provided a predefined set of tags?
Hadley
On Sat, Dec 29, 2012 at 11:40 PM, Johannes Graumann

Post by Johannes Graumann
Hello,
Is there a ROxygen-integral mechanism for doc-type specific templating?
What I am looking for is a way in which I can define what ROxygen tags
are expected/required in a function, a class, a data set. If
documentation wouldn't comply to thosre rools there would be a warning
at "document()"- time ...
Thanks for your consideration.
Sincerely, Joh
_______________________________________________
Roxygen-devel mailing list
Roxygen-devel at lists.r-forge.r-project.org
https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/roxygen-deve
l

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: This is a digitally signed message part.
URL: <http://lists.r-forge.r-project.org/pipermail/roxygen-devel/attachments/20130104/030d7955/attachment.sig>

[Hadley Wickham]

Hmmm, I'd prefer to just rely on the existing tools for checking Rd
files. Otherwise you end up having the same requirements coded in two
different places.

Hadley

On Fri, Jan 4, 2013 at 1:17 AM, Johannes Graumann

Post by Johannes Graumann
Hello Hadley,
Exactly. Something like
In case the documented thing is a function we are
@examples
@details
...
@seealso
...
In case the documented thing is a data set ...
etc.
Wouldn't that make sense?
Joh

Post by Hadley Wickham
Hi Johannes,
I'm not sure what the purpose would be do - do you want some automated
way of ensuring that you've provided a predefined set of tags?
Hadley
On Sat, Dec 29, 2012 at 11:40 PM, Johannes Graumann

Post by Johannes Graumann
Hello,
Is there a ROxygen-integral mechanism for doc-type specific templating?
What I am looking for is a way in which I can define what ROxygen tags
are expected/required in a function, a class, a data set. If
documentation wouldn't comply to thosre rools there would be a warning
at "document()"- time ...
Thanks for your consideration.
Sincerely, Joh
_______________________________________________
Roxygen-devel mailing list
Roxygen-devel at lists.r-forge.r-project.org
https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/roxygen-deve
l