New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CRAN packages using texi2dvi in vignettes/Makefile #158

Closed
jarioksa opened this Issue Feb 23, 2016 · 5 comments

Comments

Projects
None yet
1 participant
@jarioksa
Contributor

jarioksa commented Feb 23, 2016

Below an email from CRAN:

This concerns packages

HandTill2001 hsdar maSAE vegan

which do as the subject line says. There are number of problems:

a) texi2dvi need not be present. It is an optional install on
Unix-alikes, and MiKTeX on Windows removed it in late 2015.

b) It might be present and not work. The version in texinfo 6.0 uses
bashisms not in POSIX /bin/sh, and that in 6.1 fails when repeated LaTeX
runs are needed (as in hsdar maSAE vegan).

So your usages need correction. Do consider if the Makefile is needed
at all and whether standard mechanisms could be used. If it is needed,
a construction like

$(R_HOME)/bin/Rscript -e "tools::texi2pdf('name.tex', clean = TRUE)"

is more portable. For vegan, which has a .texi file, texi2pdf is
probably needed for that file and should be in SystemRequirements.

Brian D. Ripley, ripley@stats.ox.ac.uk
Emeritus Professor of Applied Statistics, University of Oxford

@jarioksa

This comment has been minimized.

Show comment
Hide comment
@jarioksa

jarioksa Feb 23, 2016

Contributor

An obvious solution is to remove texi2pdf dependence. Branch https://github.com/vegandevs/vegan/tree/texi2dvi-removal removes Makefile and translates FAQ-vegan.texi to FAQ-vegan.Rmd and uses knitr to build it to a standard .html vignette (but not to .pdf).

Changes to previous behaviour are:

  • No NEWS.html is generated, but we only have inst/NEWS.Rd. The html was generated by Makefile that was now dropped.
  • No FAQ-vegan.pdf is generated, but we only have 'inst/doc/FAQ-vegan.html`.

These changes mean that vegandocs() must be re-structured or reconsidered. The vegandocs() function was originally designed to show non-vignette documentation. Now R has developed and all that documentation may be accessible without having a dedicated vegandocs() function.

Contributor

jarioksa commented Feb 23, 2016

An obvious solution is to remove texi2pdf dependence. Branch https://github.com/vegandevs/vegan/tree/texi2dvi-removal removes Makefile and translates FAQ-vegan.texi to FAQ-vegan.Rmd and uses knitr to build it to a standard .html vignette (but not to .pdf).

Changes to previous behaviour are:

  • No NEWS.html is generated, but we only have inst/NEWS.Rd. The html was generated by Makefile that was now dropped.
  • No FAQ-vegan.pdf is generated, but we only have 'inst/doc/FAQ-vegan.html`.

These changes mean that vegandocs() must be re-structured or reconsidered. The vegandocs() function was originally designed to show non-vignette documentation. Now R has developed and all that documentation may be accessible without having a dedicated vegandocs() function.

@jarioksa

This comment has been minimized.

Show comment
Hide comment
@jarioksa

jarioksa Feb 23, 2016

Contributor

The following standard R commands work:

news(package="vegan")
vignette("FAQ-vegan", package="vegan")
vignette("decision-vegan", package="vegan")
vignette("intro-vegan", package="vegan")
vignette("diversity-vegan", package="vegan")

The NEWS and FAQ opened in a web browser and the other documents as pdf files in my desktop Linux. The vignette names could not be abbreviated. The only thing missing is partitioning.pdf. We need to find a solution for that, but otherwise I suggest vegandocs() is phased out.

Contributor

jarioksa commented Feb 23, 2016

The following standard R commands work:

news(package="vegan")
vignette("FAQ-vegan", package="vegan")
vignette("decision-vegan", package="vegan")
vignette("intro-vegan", package="vegan")
vignette("diversity-vegan", package="vegan")

The NEWS and FAQ opened in a web browser and the other documents as pdf files in my desktop Linux. The vignette names could not be abbreviated. The only thing missing is partitioning.pdf. We need to find a solution for that, but otherwise I suggest vegandocs() is phased out.

@jarioksa

This comment has been minimized.

Show comment
Hide comment
@jarioksa

jarioksa Feb 23, 2016

Contributor

texinfo 6.1 causes problems with R. R has some tricks to circumvent these problems, but vegan fails. The latest texinfo is now in Debian, and Kurt Hornik preferred a quick fix. Moving to .Rmdwill fix this in the main branch, but that conflicts with the cran-2.3 branch, and I made there a q quick fix that only replaces the vignettes/FAQ-vegan.texi with a plain text inst/FAQ-vegan and removes vignettes/Makefile. The fix is available in https://github.com/vegandevs/vegan/tree/issue-%23158-quick-fix. This also means that we shall have vegan 2.3-4. This will be a real minor release: apart from the .texi fix it will only have fixes for linestack labels, simper print and biodiver index 19.

Contributor

jarioksa commented Feb 23, 2016

texinfo 6.1 causes problems with R. R has some tricks to circumvent these problems, but vegan fails. The latest texinfo is now in Debian, and Kurt Hornik preferred a quick fix. Moving to .Rmdwill fix this in the main branch, but that conflicts with the cran-2.3 branch, and I made there a q quick fix that only replaces the vignettes/FAQ-vegan.texi with a plain text inst/FAQ-vegan and removes vignettes/Makefile. The fix is available in https://github.com/vegandevs/vegan/tree/issue-%23158-quick-fix. This also means that we shall have vegan 2.3-4. This will be a real minor release: apart from the .texi fix it will only have fixes for linestack labels, simper print and biodiver index 19.

@jarioksa jarioksa modified the milestones: v2.3-4, v2.4-0, 2.3-1, 2.4-0 Feb 24, 2016

@jarioksa

This comment has been minimized.

Show comment
Hide comment
@jarioksa

jarioksa Feb 25, 2016

Contributor

The texi2dvi issue and other anomalies were fixed in 3035e70. The changes can be ported to cran-2.3 and after cherry-picking, we'll release vegan-2.3-4.

Contributor

jarioksa commented Feb 25, 2016

The texi2dvi issue and other anomalies were fixed in 3035e70. The changes can be ported to cran-2.3 and after cherry-picking, we'll release vegan-2.3-4.

jarioksa added a commit that referenced this issue Feb 25, 2016

@jarioksa

This comment has been minimized.

Show comment
Hide comment
@jarioksa

jarioksa Feb 26, 2016

Contributor

Closed with the v2.3-4 release.

Contributor

jarioksa commented Feb 26, 2016

Closed with the v2.3-4 release.

@jarioksa jarioksa closed this Feb 26, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment