[BioC] Package xps - Problem accessing README file

[Kasper Daniel Hansen]

Dan

There are by now quite a few packages that have detailed installation
instructions in a README file (or perhaps an INSTALL file).  This is
typically caused by depending on external software that needs to be
installed.  I believe it would be a worthwhile addition to the
webpages if they mirror README files.  See for example Rgraphviz.  In
addition it would be helpful if they mirror a ChangeLog/NEWS file,
CRAN already does that.

It might be worthwhile talking to the CRAN people and see if you could
use common code...?

Of course, this may be too much trouble, but I think it would be worth
it (which is easy to say when I am not doing the work :)

Kasper

On Tue, Nov 23, 2010 at 4:33 PM, cstrato <cstrato at aon.at> wrote:
> Dear Dan, dear Henrik,
>
> Thank you Henrik for your suggestion, this is a great idea.
>
> Thank you Dan for your suggestion to give more information on the
> DESCRIPTION file. At the moment I have decided to leave it as is. Next time
> I can point users to the current topic so that they are able to access the
> README file as Henrik has suggested.
>
> As a side note, since README is one of the mostly used files for almost
> everything, I was always wondering why R and/or Bioconductor does not force
> package developers to submit a README file with their packages.
>
> Best regards
> Christian
>
>
> On 11/22/10 11:07 PM, Dan Tenenbaum wrote:
>>
>>
>> On Mon, Nov 22, 2010 at 1:50 PM, Henrik Bengtsson <hb at biostat.ucsf.edu
>> <mailto:hb at biostat.ucsf.edu>> wrote:
>>
>>    Alternatively, grab the README file from the SVN server:
>>
>>
>>  https://hedgehog.fhcrc.org/bioconductor/branches/RELEASE_2_7/madman/Rpacks/xps/README
>>
>>    Username and password as on
>>    http://bioconductor.org/developers/source-control/
>>
>>    To BioC core: Since the username and pwd is already above, is it ok
>>    post the URL with
>>    https://<username>:<password>@hedgehog.fhcrc.org/..
>>    <http://hedgehog.fhcrc.org/..>.?  (Can imagine
>>    that opens up for crawlers etc that you might not want to have in
>>    there).
>>
>>
>> Thanks Henrik.
>>
>> To be safe, let's not put the full URL together, but by all means, we
>> can point out that our Subversion repository is accessible  at :
>>
>> https://hedgehog.fhcrc.org/bioconductor/
>>
>> ...with the username and password listed on:
>>
>> http://bioconductor.org/developers/source-control/
>> (unless you have another username and password you got from us).
>>
>>
>> In other words:
>> https://username:password@hedgehog.fhcrc.org/bioconductor
>>
>> ...substituting the correct username and password.
>>
>> To find a given package, look here (for devel):
>>
>>
>>
>> https://hedgehog.fhcrc.org/bioconductor/branches/trunk/madman/Rpacks/PACKAGE_NAME
>>
>> or, for release (currently 2.7), here:
>>
>>
>> https://hedgehog.fhcrc.org/bioconductor/branches/RELEASE_2_7/madman/PACKAGE_NAME
>>
>> Thanks
>> Dan
>>
>>
>>
>>
>>
>>    /Henrik
>>
>>    On Mon, Nov 22, 2010 at 11:47 AM, cstrato <cstrato at aon.at
>>    <mailto:cstrato at aon.at>> wrote:
>>     > Dear Marcos,
>>     >
>>     > Please download the source code so that you have access to the
>>    README file.
>>     > Regards Christian
>>     >
>>     >
>>     > Dear BioC maintainers,
>>     >
>>     > Since some users have asked me how to access the README file,
>>    which explains
>>     > how to install ROOT and xps but is currently only accessible when
>>    xps is
>>     > already installed or when you download the source code, my
>>    question is:
>>     > Would it be possible to make a link to the README file in the
>>    Documentation
>>     > section of the BioC packages analogously to the Vignettes?
>>     >
>>     > Thank you in advance
>>     > Best regards
>>     > Christian
>>     > _._._._._._._._._._._._._._._._._._
>>     > C.h.r.i.s.t.i.a.n   S.t.r.a.t.o.w.a
>>     > V.i.e.n.n.a           A.u.s.t.r.i.a
>>     > e.m.a.i.l:        cstrato at aon.at <http://aon.at>
>>     > _._._._._._._._._._._._._._._._._._
>>     >
>>     >
>>     > On 11/22/10 8:18 PM, Marcos Pinho wrote:
>>     >>
>>     >> Dear List,
>>     >>
>>     >> could anybody help me with the installation and usage of the
>>    package xps?
>>     >> I
>>     >> am trying to use the package, have downloaded and read all the info
>>     >> material
>>     >> and could not understand how the install  ROOT and how to run it
>>    with the
>>     >> xps package.
>>     >>
>>     >> Any help would be greatly appreciated
>>     >>
>>     >> Cheers,
>>     >>
>>     >>
>>     >>
>>     >>
>>     >> _______________________________________________
>>     >> Bioconductor mailing list
>>     >> Bioconductor at stat.math.ethz.ch
>>    <mailto:Bioconductor at stat.math.ethz.ch>
>>     >> https://stat.ethz.ch/mailman/listinfo/bioconductor
>>     >> Search the archives:
>>     >> http://news.gmane.org/gmane.science.biology.informatics.conductor
>>     >
>>     > _______________________________________________
>>     > Bioconductor mailing list
>>     > Bioconductor at stat.math.ethz.ch
>>    <mailto:Bioconductor at stat.math.ethz.ch>
>>     > https://stat.ethz.ch/mailman/listinfo/bioconductor
>>     > Search the archives:
>>     > http://news.gmane.org/gmane.science.biology.informatics.conductor
>>     >
>>
>>    _______________________________________________
>>    Bioconductor mailing list
>>    Bioconductor at stat.math.ethz.ch <mailto:Bioconductor at stat.math.ethz.ch>
>>    https://stat.ethz.ch/mailman/listinfo/bioconductor
>>    Search the archives:
>>    http://news.gmane.org/gmane.science.biology.informatics.conductor
>>
>>
>
> _______________________________________________
> Bioconductor mailing list
> Bioconductor at stat.math.ethz.ch
> https://stat.ethz.ch/mailman/listinfo/bioconductor
> Search the archives:
> http://news.gmane.org/gmane.science.biology.informatics.conductor
>