Quantcast

Usage line in .pdf version of manual is truncated

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

Usage line in .pdf version of manual is truncated

Zeeberg, Barry (NIH/NCI) [E]
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?

______________________________________________
[hidden email] 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.
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

Re: Usage line in .pdf version of manual is truncated

Joshua Wiley-2
Break the line :)

On Mon, Apr 30, 2012 at 12:34 PM, Zeeberg, Barry (NIH/NCI) [E]
<[hidden email]> 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?
>
> ______________________________________________
> [hidden email] 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/

______________________________________________
[hidden email] 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.
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

Re: Usage line in .pdf version of manual is truncated

plangfelder
In reply to this post by Zeeberg, Barry (NIH/NCI) [E]
On Mon, Apr 30, 2012 at 12:34 PM, Zeeberg, Barry (NIH/NCI) [E]
<[hidden email]> 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

______________________________________________
[hidden email] 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.
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate
star

Re: Usage line in .pdf version of manual is truncated

Yihui Xie-2
In reply to this post by Joshua Wiley-2
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 <[hidden email]>
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 <[hidden email]> wrote:
> Break the line :)
>
> On Mon, Apr 30, 2012 at 12:34 PM, Zeeberg, Barry (NIH/NCI) [E]
> <[hidden email]> 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?

______________________________________________
[hidden email] 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.
Loading...