<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><div><div>Dear roxygen users,</div><div><br></div><div>below it posted a mini example in which I want do write documentation for</div><div>an “[“ method for a S4 class. Does someone know how to properly document it in roxygen?</div><div>I get a warning when checking the package after building (see below).</div><div><br></div><div><br></div><div>#' An S4 class that stores a string.</div><div>#' @slot a contains a string</div><div>#' @export</div><div>setClass("testClass", </div><div><span class="Apple-tab-span" style="white-space:pre"> </span> representation(a="character"))</div><div><br></div><div><br></div><div>#' extract method for testClass</div><div>#'</div><div>#' @docType methods</div><div>#' @rdname extract-methods</div><div>setMethod("[", signature(x = "testClass", i = "ANY", j="ANY"),</div><div> function (x, i, j, ..., drop){</div><div> print("void function")</div><div> }</div><div>)</div><div><br></div><div>Excerpt from package check:</div><div>...</div><div>* checking for missing documentation entries ... WARNING</div><div>Undocumented S4 methods:</div><div> generic '[' and siglist 'testClass'</div><div>All user-level objects in a package (including S4 classes and methods)</div><div>should have documentation entries.</div><div>See the chapter 'Writing R documentation files' in manual 'Writing R</div><div>Extensions'.</div></div><div>...</div><div><br></div><div>Thanks in advance,</div><div>Mark</div><div><br></div><div><br></div><div><br></div><br><div>
<div>–––––––––––––––––––––––––––––––––––––––<br><div><div apple-content-edited="true"><span class="Apple-style-span" style="border-collapse: separate; color: rgb(0, 0, 0); font-family: Helvetica; font-size: medium; font-style: normal; font-variant: normal; font-weight: normal; letter-spacing: normal; line-height: normal; orphans: 2; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-border-horizontal-spacing: 0px; -webkit-border-vertical-spacing: 0px; -webkit-text-decorations-in-effect: none; -webkit-text-size-adjust: auto; -webkit-text-stroke-width: 0px; "><div style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><span class="Apple-style-span" style="border-collapse: separate; color: rgb(0, 0, 0); font-family: Helvetica; font-size: medium; font-style: normal; font-variant: normal; font-weight: normal; letter-spacing: normal; line-height: normal; orphans: 2; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-border-horizontal-spacing: 0px; -webkit-border-vertical-spacing: 0px; -webkit-text-decorations-in-effect: none; -webkit-text-size-adjust: auto; -webkit-text-stroke-width: 0px; "><div style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><span class="Apple-style-span" style="border-collapse: separate; color: rgb(0, 0, 0); font-family: Helvetica; font-size: medium; font-style: normal; font-variant: normal; font-weight: normal; letter-spacing: normal; line-height: normal; orphans: 2; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-border-horizontal-spacing: 0px; -webkit-border-vertical-spacing: 0px; -webkit-text-decorations-in-effect: none; -webkit-text-size-adjust: auto; -webkit-text-stroke-width: 0px; "><div style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><div><div><font class="Apple-style-span" color="#5C5C5C"><font class="Apple-style-span" size="3"><span class="Apple-style-span" style="font-size: 12px; "><font class="Apple-style-span" face="Verdana">Mark Heckmann</font></span></font></font></div><div><font class="Apple-style-span" color="#5C5C5C"><font class="Apple-style-span" size="3"><span class="Apple-style-span" style="font-size: 12px; "><font class="Apple-style-span" face="Verdana">Blog: </font></span></font></font><a href="http://www.markheckmann.de/"><font class="Apple-style-span" color="#5C5C5C"><font class="Apple-style-span" size="3"><span class="Apple-style-span" style="font-size: 12px; "><font class="Apple-style-span" face="Verdana">www.markheckmann.de</font></span></font></font></a></div><div><div><font class="Apple-style-span" color="#5C5C5C"><font class="Apple-style-span" size="3"><span class="Apple-style-span" style="font-size: 12px; "><font class="Apple-style-span" face="Verdana">R-Blog: <span class="Apple-style-span" style="color: rgb(0, 0, 0); font-family: Helvetica; font-size: medium; "><a href="http://ryouready.wordpress.com/"><font class="Apple-style-span" color="#5C5C5C"><font class="Apple-style-span" size="3"><span class="Apple-style-span" style="font-size: 12px; "><font class="Apple-style-span" face="Verdana">http://ryouready.wordpress.com</font></span></font></font></a></span></font></span></font></font></div></div></div></div></span></div></span></div></span></div></div></div><div><br></div><br class="Apple-interchange-newline">
</div>
<br></body></html>