Dear helpers, I have multiple vignette files for a package, and I would like to have the "right" order of these files when displayed online. For instance, see below: https://cran.r-project.org/web/packages/bst/index.html The order of vignette links on CRAN is different from what I hoped for:> vignette(package="bst")Vignettes in package 'bst': pros Cancer Classification Using Mass Spectrometry-based Proteomics Data (source, pdf) static_khan Classification of Cancer Types Using Gene Expression Data (Long) (source, pdf) khan Classification of Cancer Types Using Gene Expression Data (Short) (source, pdf) static_mcl Classification of UCI Machine Learning Datasets (Long) (source, pdf) mcl Classification of UCI Machine Learning Datasets (Short) (source, pdf) The package bst already has an index.html, and I thought that should have done the job, but apparently not. Any suggestions? Thanks, Zhu /bst/inst/doc/index.html <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head><title>R: Vignettes and other documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <link rel="stylesheet" type="text/css" href="/doc/html/R.css" /> </head><body> <h1> Vignettes and other documentation <img class="toplogo" src="/doc/html/logo.jpg" alt="[R logo]" /> </h1> <hr/> <div style="text-align: center;"> <a href="/doc/html/index.html"><img class="arrow" src="/doc/html/up.jpg" alt="[Top]" /></a> </div> <h2>Vignettes from package 'bst'</h2> <table width="100%"> <col style="width: 22%;" /> <col style="width: 2%;" /> <col style="width: 50%;" /> <col style="width: 8%;" /> <col style="width: 8%;" /> <col style="width: 8%;" /> <tr><td style="text-align: right; vertical-align: top;"><a href="../../../library/bst/doc/pros.pdf">bst::pros</a></td> <td></td><td valign="top">Cancer Classification Using Mass Spectrometry-based Proteomics Data</td> <td valign="top"><a href="../../../library/bst/doc/pros.pdf">PDF</a></td> <td valign="top"><a href="../../../library/bst/doc/pros.Rnw">source</a></td> <td valign="top" style="white-space: nowrap"><a href="../../../library/bst/doc/pros.R">R code</a></td></tr> <tr><td style="text-align: right; vertical-align: top;"><a href="../../../library/bst/doc/static_khan.pdf">bst::static_khan</a></td> <td></td><td valign="top">Classification of Cancer Types Using Gene Expression Data (Long)</td> <td valign="top"><a href="../../../library/bst/doc/static_khan.pdf">PDF</a></td> <td valign="top"><a href="../../../library/bst/doc/static_khan.pdf.asis">source</a></td> <td valign="top" style="white-space: nowrap"></td></tr> <tr><td style="text-align: right; vertical-align: top;"><a href="../../../library/bst/doc/khan.pdf">bst::khan</a></td> <td></td><td valign="top">Classification of Cancer Types Using Gene Expression Data (Short)</td> <td valign="top"><a href="../../../library/bst/doc/khan.pdf">PDF</a></td> <td valign="top"><a href="../../../library/bst/doc/khan.Rnw">source</a></td> <td valign="top" style="white-space: nowrap"><a href="../../../library/bst/doc/khan.R">R code</a></td></tr> <tr><td style="text-align: right; vertical-align: top;"><a href="../../../library/bst/doc/static_mcl.pdf">bst::static_mcl</a></td> <td></td><td valign="top">Classification of UCI Machine Learning Datasets (Long)</td> <td valign="top"><a href="../../../library/bst/doc/static_mcl.pdf">PDF</a></td> <td valign="top"><a href="../../../library/bst/doc/static_mcl.pdf.asis">source</a></td> <td valign="top" style="white-space: nowrap"></td></tr> <tr><td style="text-align: right; vertical-align: top;"><a href="../../../library/bst/doc/mcl.pdf">bst::mcl</a></td> <td></td><td valign="top">Classification of UCI Machine Learning Datasets (Short)</td> <td valign="top"><a href="../../../library/bst/doc/mcl.pdf">PDF</a></td> <td valign="top"><a href="../../../library/bst/doc/mcl.Rnw">source</a></td> <td valign="top" style="white-space: nowrap"><a href="../../../library/bst/doc/mcl.R">R code</a></td></tr> </table> </body></html> ../../Rpkg/bst/inst/doc/index.html (END) **Connecticut Children's Confidentiality Notice** This e-mail message, including any attachments, is for t...{{dropped:8}}
This probably belongs on r-package-devel at r-project.org as it is not about the development of R itself, but about package development. -- Brian On Fri, 2016-03-04 at 14:44 +0000, Wang, Zhu wrote:> Dear helpers, > > I have multiple vignette files for a package, and I would like to have the "right" order of these files when displayed online. For instance, see below: > > https://cran.r-project.org/web/packages/bst/index.html > > The order of vignette links on CRAN is different from what I hoped for: > > > vignette(package="bst") > Vignettes in package 'bst': > > pros Cancer Classification Using Mass > Spectrometry-based Proteomics Data (source, > pdf) > static_khan Classification of Cancer Types Using Gene > Expression Data (Long) (source, pdf) > khan Classification of Cancer Types Using Gene > Expression Data (Short) (source, pdf) > static_mcl Classification of UCI Machine Learning Datasets > (Long) (source, pdf) > mcl Classification of UCI Machine Learning Datasets > (Short) (source, pdf) > > The package bst already has an index.html, and I thought that should have done the job, but apparently not. Any suggestions? > > Thanks, > > Zhu > > /bst/inst/doc/index.html > <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> > <html xmlns="http://www.w3.org/1999/xhtml"> > <head><title>R: Vignettes and other documentation</title> > <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> > <link rel="stylesheet" type="text/css" href="/doc/html/R.css" /> > </head><body> > <h1> Vignettes and other documentation > <img class="toplogo" src="/doc/html/logo.jpg" alt="[R logo]" /> > </h1> > <hr/> > <div style="text-align: center;"> > <a href="/doc/html/index.html"><img class="arrow" src="/doc/html/up.jpg" alt="[Top]" /></a> > </div> > <h2>Vignettes from package 'bst'</h2> > <table width="100%"> > <col style="width: 22%;" /> > <col style="width: 2%;" /> > <col style="width: 50%;" /> > <col style="width: 8%;" /> > <col style="width: 8%;" /> > <col style="width: 8%;" /> > <tr><td style="text-align: right; vertical-align: top;"><a href="../../../library/bst/doc/pros.pdf">bst::pros</a></td> > <td></td><td valign="top">Cancer Classification Using Mass Spectrometry-based Proteomics Data</td> > <td valign="top"><a href="../../../library/bst/doc/pros.pdf">PDF</a></td> > <td valign="top"><a href="../../../library/bst/doc/pros.Rnw">source</a></td> > <td valign="top" style="white-space: nowrap"><a href="../../../library/bst/doc/pros.R">R code</a></td></tr> > <tr><td style="text-align: right; vertical-align: top;"><a href="../../../library/bst/doc/static_khan.pdf">bst::static_khan</a></td> > <td></td><td valign="top">Classification of Cancer Types Using Gene Expression Data (Long)</td> > <td valign="top"><a href="../../../library/bst/doc/static_khan.pdf">PDF</a></td> > <td valign="top"><a href="../../../library/bst/doc/static_khan.pdf.asis">source</a></td> > <td valign="top" style="white-space: nowrap"></td></tr> > <tr><td style="text-align: right; vertical-align: top;"><a href="../../../library/bst/doc/khan.pdf">bst::khan</a></td> > <td></td><td valign="top">Classification of Cancer Types Using Gene Expression Data (Short)</td> > <td valign="top"><a href="../../../library/bst/doc/khan.pdf">PDF</a></td> > <td valign="top"><a href="../../../library/bst/doc/khan.Rnw">source</a></td> > <td valign="top" style="white-space: nowrap"><a href="../../../library/bst/doc/khan.R">R code</a></td></tr> > <tr><td style="text-align: right; vertical-align: top;"><a href="../../../library/bst/doc/static_mcl.pdf">bst::static_mcl</a></td> > <td></td><td valign="top">Classification of UCI Machine Learning Datasets (Long)</td> > <td valign="top"><a href="../../../library/bst/doc/static_mcl.pdf">PDF</a></td> > <td valign="top"><a href="../../../library/bst/doc/static_mcl.pdf.asis">source</a></td> > <td valign="top" style="white-space: nowrap"></td></tr> > <tr><td style="text-align: right; vertical-align: top;"><a href="../../../library/bst/doc/mcl.pdf">bst::mcl</a></td> > <td></td><td valign="top">Classification of UCI Machine Learning Datasets (Short)</td> > <td valign="top"><a href="../../../library/bst/doc/mcl.pdf">PDF</a></td> > <td valign="top"><a href="../../../library/bst/doc/mcl.Rnw">source</a></td> > <td valign="top" style="white-space: nowrap"><a href="../../../library/bst/doc/mcl.R">R code</a></td></tr> > </table> > </body></html> > ../../Rpkg/bst/inst/doc/index.html (END) > > > **Connecticut Children's Confidentiality Notice** > This e-mail message, including any attachments, is for...{{dropped:6}}
On 04/03/2016 9:44 AM, Wang, Zhu wrote:> Dear helpers, > > I have multiple vignette files for a package, and I would like to have the "right" order of these files when displayed online. For instance, see below: > > https://cran.r-project.org/web/packages/bst/index.html > > The order of vignette links on CRAN is different from what I hoped for: > > > vignette(package="bst") > Vignettes in package 'bst': > > pros Cancer Classification Using Mass > Spectrometry-based Proteomics Data (source, > pdf) > static_khan Classification of Cancer Types Using Gene > Expression Data (Long) (source, pdf) > khan Classification of Cancer Types Using Gene > Expression Data (Short) (source, pdf) > static_mcl Classification of UCI Machine Learning Datasets > (Long) (source, pdf) > mcl Classification of UCI Machine Learning Datasets > (Short) (source, pdf) > > The package bst already has an index.html, and I thought that should have done the job, but apparently not. Any suggestions? >The index.html file should be used in the online help system, but vignette() doesn't use that, it looks in the internal database of vignettes. I don't think you can control the order in which it displays things. This could conceivably be changed, but not by consulting your index.html file --- it is not required to follow a particular structure, so we can't find what order you want from it. One more likely possibility would be to sort alphabetically in the current locale according to filename or vignette title. So then you could get what you want by naming your vignettes 1pros, 2static_khan, etc. It would also be possible to add a new \VignetteXXXX directive so affect collation order, but that seems like overkill. Duncan Murdoch
I think the online order of vignette files are not based on vignette title or filename alphabetically. I am just curious: by what order these vignette files were displayed online so I can make changes accordingly? Thanks, Zhu -----Original Message----- From: Duncan Murdoch [mailto:murdoch.duncan at gmail.com] Sent: Friday, March 04, 2016 10:47 AM To: Wang, Zhu; r-devel at r-project.org Subject: Re: [Rd] vignette index On 04/03/2016 9:44 AM, Wang, Zhu wrote:> Dear helpers, > > I have multiple vignette files for a package, and I would like to have the "right" order of these files when displayed online. For instance, see below: > > https://cran.r-project.org/web/packages/bst/index.html > > The order of vignette links on CRAN is different from what I hoped for: > > > vignette(package="bst") > Vignettes in package 'bst': > > pros Cancer Classification Using Mass > Spectrometry-based Proteomics Data (source, > pdf) > static_khan Classification of Cancer Types Using Gene > Expression Data (Long) (source, pdf) > khan Classification of Cancer Types Using Gene > Expression Data (Short) (source, pdf) > static_mcl Classification of UCI Machine Learning Datasets > (Long) (source, pdf) > mcl Classification of UCI Machine Learning Datasets > (Short) (source, pdf) > > The package bst already has an index.html, and I thought that should have done the job, but apparently not. Any suggestions? >The index.html file should be used in the online help system, but vignette() doesn't use that, it looks in the internal database of vignettes. I don't think you can control the order in which it displays things. This could conceivably be changed, but not by consulting your index.html file --- it is not required to follow a particular structure, so we can't find what order you want from it. One more likely possibility would be to sort alphabetically in the current locale according to filename or vignette title. So then you could get what you want by naming your vignettes 1pros, 2static_khan, etc. It would also be possible to add a new \VignetteXXXX directive so affect collation order, but that seems like overkill. Duncan Murdoch **Connecticut Children's Confidentiality Notice** This e-mail message, including any attachments, is for t...{{dropped:8}}