Re: [Rd] Wishlist: Vignettes on CRAN
On Mon, 22 May 2006 21:42:34 -0700, Seth Falcon (SF) wrote: Gabor Grothendieck [EMAIL PROTECTED] writes: This would certainly be nice. Note that the BioConductor package vignettes are online: http://www.bioconductor.org/docs/vignettes.html but there is nothing comparable for CRAN. That page is actually out of date (we'll be updating it real soon now). However, we are producing links to package vingnettes in the automatically generated package summary pages. For example, take a look at the summary page for the Biobase package: http://bioconductor.org/packages/1.8/bioc/html/Biobase.html This was fairly easy to setup. I would be happy to share the code, etc. That looks excellent, I would be happy to use somethink like that for CRAN. But as Kurt already said: looks more like a summer project (currently I am swamped with teaching). .f __ R-devel@r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-devel
Re: [Rd] Wishlist: Vignettes on CRAN
Dirk Eddelbuettel writes: On 22 May 2006 at 23:24, Gabor Grothendieck wrote: | This would certainly be nice. | | Note that the BioConductor package vignettes are online: |http://www.bioconductor.org/docs/vignettes.html | but there is nothing comparable for CRAN. | | In some cases the package has a home page mentioned in the | URL field of the DESCRIPTION file and following that can sometimes | get vignette or other information although I agree we really need | a standardized way to discover that a vignette exists and to access | it without installing the package. | | It would also be nice to be able to access the ChangeLog or NEWS | file online as well as from the installed package. Currently one has | to download and unpack the source to get it in many cases and even | then one can't even be sure that it exists. That's even worse than | the sitution with vignettes. If we agreed on a (voluntary, of course) format and location for NEWS and/or ChangeLog, then it would be easy to parse these from freshly uploaded files and do value-added tricks like RSS feeds of changes, new uploads, ... I still don't think there can be one format to agree upon. Imho it would be better to have package (DESCRIPTION) metadata pointing to the changelog/news db and maybe also providing an indication of its format. -k __ R-devel@r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-devel
Re: [Rd] Wishlist: Vignettes on CRAN
McGehee, Robert writes: I was recently browsing through CRAN's Finance task view to remind myself of the publicly available packages relevant to my work. As the reference manuals are all online, I am able to flip through the available functions to get an idea of the package's scope before downloading. That said, many authors have taken the time to additionally provide a useful vignette which provides a better overview to complicated packages. However, as far as I can tell, the only way to read or even know if a package has a vignette is to first download and unpack the package source, which is inconvenient when one wants to understand a package _before_ installing. Perhaps an easy way to make vignettes more accessible to the end user would be to link the vignette PDF directly to the download page so that one could download it just as one can download the reference manual or package source. This both publicizes the vignette (since many users may even be unaware that a package has a vignette) and facilitates browsing. Yes, that would be very useful. Will have a look, but this looks like something for the summer break. Best -k __ R-devel@r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-devel
Re: [Rd] Wishlist: Vignettes on CRAN
Might it be feasible to just bundle any vignettes with the help file?
Wouldn't this make them more accessible to, e.g., RSiteSearch?
Just a thought. Spencer Graves
McGehee, Robert wrote:
I was recently browsing through CRAN's Finance task view to remind
myself of the publicly available packages relevant to my work. As the
reference manuals are all online, I am able to flip through the
available functions to get an idea of the package's scope before
downloading.
That said, many authors have taken the time to additionally provide a
useful vignette which provides a better overview to complicated
packages. However, as far as I can tell, the only way to read or even
know if a package has a vignette is to first download and unpack the
package source, which is inconvenient when one wants to understand a
package _before_ installing.
Perhaps an easy way to make vignettes more accessible to the end user
would be to link the vignette PDF directly to the download page so that
one could download it just as one can download the reference manual or
package source. This both publicizes the vignette (since many users may
even be unaware that a package has a vignette) and facilitates browsing.
Just a thought!
Best,
Robert
Robert McGehee
Quantitative Analyst
Geode Capital Management, LLC
53 State Street, 5th Floor | Boston, MA | 02109
Tel: 617/392-8396Fax:617/476-6389
mailto:[EMAIL PROTECTED]
This e-mail, and any attachments hereto, are intended for us...{{dropped}}
__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
Re: [Rd] Wishlist: Vignettes on CRAN
This would certainly be nice.
Note that the BioConductor package vignettes are online:
http://www.bioconductor.org/docs/vignettes.html
but there is nothing comparable for CRAN.
In some cases the package has a home page mentioned in the
URL field of the DESCRIPTION file and following that can sometimes
get vignette or other information although I agree we really need
a standardized way to discover that a vignette exists and to access
it without installing the package.
It would also be nice to be able to access the ChangeLog or NEWS
file online as well as from the installed package. Currently one has
to download and unpack the source to get it in many cases and even
then one can't even be sure that it exists. That's even worse than
the sitution with vignettes.
On 5/22/06, McGehee, Robert [EMAIL PROTECTED] wrote:
I was recently browsing through CRAN's Finance task view to remind
myself of the publicly available packages relevant to my work. As the
reference manuals are all online, I am able to flip through the
available functions to get an idea of the package's scope before
downloading.
That said, many authors have taken the time to additionally provide a
useful vignette which provides a better overview to complicated
packages. However, as far as I can tell, the only way to read or even
know if a package has a vignette is to first download and unpack the
package source, which is inconvenient when one wants to understand a
package _before_ installing.
Perhaps an easy way to make vignettes more accessible to the end user
would be to link the vignette PDF directly to the download page so that
one could download it just as one can download the reference manual or
package source. This both publicizes the vignette (since many users may
even be unaware that a package has a vignette) and facilitates browsing.
Just a thought!
Best,
Robert
Robert McGehee
Quantitative Analyst
Geode Capital Management, LLC
53 State Street, 5th Floor | Boston, MA | 02109
Tel: 617/392-8396Fax:617/476-6389
mailto:[EMAIL PROTECTED]
This e-mail, and any attachments hereto, are intended for us...{{dropped}}
__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
