Zeeberg, Barry (NIH/NCI) [E]
2012-Apr-30 19:34 UTC
[R] Usage line in .pdf version of manual is truncated
I am creating a package, and a rather long usage line for one function becomes truncated in the generated .pdf manual. Is there a way that I can prevent that truncation?
Break the line :) On Mon, Apr 30, 2012 at 12:34 PM, Zeeberg, Barry (NIH/NCI) [E] <zeebergb at mail.nih.gov> wrote:> I am creating a package, and a rather long usage line for one function becomes truncated in the generated .pdf manual. Is there a way that I can prevent that truncation? > > ______________________________________________ > R-help at 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.-- Joshua Wiley Ph.D. Student, Health Psychology Programmer Analyst II, Statistical Consulting Group University of California, Los Angeles https://joshuawiley.com/
Peter Langfelder
2012-May-01 04:07 UTC
[R] Usage line in .pdf version of manual is truncated
On Mon, Apr 30, 2012 at 12:34 PM, Zeeberg, Barry (NIH/NCI) [E] <zeebergb at mail.nih.gov> wrote:> I am creating a package, and a rather long usage line for one function becomes truncated in the generated .pdf manual. Is there a way that I can prevent that truncation?How long is "rather long"? In our WGCNA package we have a function whose usage line spans two pages of the pdf manual (no kidding...) and the usage is complete in the pdf manual. Perhaps there's something else going on? Peter
There is actually another approach which can do the job automatically; see the function reformat_code() in R2roxygen (remember to back up your Rd files before you use it). If you document your package with roxygen2, things can be even easier -- just call the function rab() to roxygenize and reformat code. This is what I do with all my packages. Regards, Yihui -- Yihui Xie <xieyihui at gmail.com> Phone: 515-294-2465 Web: http://yihui.name Department of Statistics, Iowa State University 2215 Snedecor Hall, Ames, IA On Mon, Apr 30, 2012 at 10:37 PM, Joshua Wiley <jwiley.psych at gmail.com> wrote:> Break the line :) > > On Mon, Apr 30, 2012 at 12:34 PM, Zeeberg, Barry (NIH/NCI) [E] > <zeebergb at mail.nih.gov> wrote: >> I am creating a package, and a rather long usage line for one function becomes truncated in the generated .pdf manual. Is there a way that I can prevent that truncation?