R devel - Nov 2008 - Line breaks in mathematical formulae in Rd files (PR#13287)

Hi,

This is a problem about writing R documentation (R-exts 2.6). The
command "\deqn" defined in "Rd.sty" is:

\newcommand{\deqn}[2]{\[#1\]}

which will put mathematical formulae in the "displaymath" environment;
that means line breaks are not allowed (or will not be shown) in
formulae, but sometimes we do need multiple lines of formulae. One
solution is to write several equations using "\deqn", but I think to
change the definition of "\deqn" is better:

\newcommand{\deqn}[2]{\begin{eqnarray*}#1\end{eqnarray*}}

This will not change the pdfLaTeX output effect, moreover, line breaks
and alignments using "&" will be available in math formulae.

Regards,
Yihui
--
Yihui Xie <xieyihui at gmail.com>
Phone: +86-(0)10-82509086 Fax: +86-(0)10-82509086
Mobile: +86-15810805877
Homepage: http://www.yihui.name
School of Statistics, Room 1037, Mingde Main Building,
Renmin University of China, Beijing, 100872, China

I think the 'problem' is a lack of attention to the manual.

   deqn gives ?displayed equations? (as in LaTeX's displaymath environment,
   or TeX's $$...$$).

seems pretty clear to me, and I hope to any LaTeX user.

On Fri, 14 Nov 2008, xieyihui at gmail.com wrote:
> Hi,
>
> This is a problem about writing R documentation (R-exts 2.6). The
> command "\deqn" defined in "Rd.sty" is:
>
> \newcommand{\deqn}[2]{\[#1\]}
>
> which will put mathematical formulae in the "displaymath"
environment;
Well, surprise, surprise it does what it is documented to do!
> that means line breaks are not allowed (or will not be shown) in
> formulae, but sometimes we do need multiple lines of formulae. One
> solution is to write several equations using "\deqn", but I think
to
> change the definition of "\deqn" is better:
>
> \newcommand{\deqn}[2]{\begin{eqnarray*}#1\end{eqnarray*}}
That will change the spacing.
> This will not change the pdfLaTeX output effect, moreover, line breaks
> and alignments using "&" will be available in math formulae.
Not to the non-latex conversions.
> Regards,
> Yihui
> --
> Yihui Xie <xieyihui at gmail.com>
> Phone: +86-(0)10-82509086 Fax: +86-(0)10-82509086
> Mobile: +86-15810805877
> Homepage: http://www.yihui.name
> School of Statistics, Room 1037, Mingde Main Building,
> Renmin University of China, Beijing, 100872, China
>
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>
-- 
Brian D. Ripley,                  ripley at stats.ox.ac.uk
Professor of Applied Statistics,  http://www.stats.ox.ac.uk/~ripley/
University of Oxford,             Tel:  +44 1865 272861 (self)
1 South Parks Road,                     +44 1865 272866 (PA)
Oxford OX1 3TG, UK                Fax:  +44 1865 272595