If I download a package -- how can I explore what it does? For instance, I downloaded the TTR package of off CRAN -- but how can I find out what it does? Is there a type of API doc for each package? JB
Discovery on packages
4 messages · JannaB, Duncan Murdoch, Phil Spector +1 more
On 5/26/2009 10:25 AM, JannaB wrote:
If I download a package -- how can I explore what it does? For instance, I downloaded the TTR package of off CRAN -- but how can I find out what it does? Is there a type of API doc for each package? JB
If you ask for help using ?TTR, you'll get an overview page. This is a recommended convention for all packages, but not all of them do it. TTR did. Duncan Murdoch
Janna -
Another thing that's sometimes useful with a new package
is to run the example function, like
example(TTR)
This will run the examples from the documentation to give
you a quick idea of what the package can do.
- Phil Spector
Statistical Computing Facility
Department of Statistics
UC Berkeley
spector at stat.berkeley.edu
On Tue, 26 May 2009, JannaB wrote:
If I download a package -- how can I explore what it does? For instance, I downloaded the TTR package of off CRAN -- but how can I find out what it does? Is there a type of API doc for each package? JB
______________________________________________ R-help at r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-help PLEASE do read the posting guide http://www.R-project.org/posting-guide.html and provide commented, minimal, self-contained, reproducible code.
"PS" == Phil Spector <spector at stat.berkeley.edu>
on Tue, 26 May 2009 09:25:26 -0700 (PDT) writes:
PS> Janna -
PS> Another thing that's sometimes useful with a new package
PS> is to run the example function, like
PS> example(TTR)
PS> This will run the examples from the documentation to give
PS> you a quick idea of what the package can do.
In addition to that, and the ?<pkg-name> ( ?TTR in this case)
hint by Duncan,
I'd like to mention the traditional
library(help = TTR) # very old: S even before there was S+
or the *equivalent*, slightly more intuitive, R - only
help(package = TTR)
Martin Maechler, ETH Zurich
PS> On Tue, 26 May 2009, JannaB wrote:
>> If I download a package -- how can I explore what it does? For
>> instance, I downloaded the TTR package of off CRAN -- but how can I
>> find out what it does? Is there a type of API doc for each package? JB
>>
>> ______________________________________________
>> R-help at r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-help
>> PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
>> and provide commented, minimal, self-contained, reproducible code.
>>
PS> ______________________________________________
PS> R-help at r-project.org mailing list
PS> https://stat.ethz.ch/mailman/listinfo/r-help
PS> PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
PS> and provide commented, minimal, self-contained, reproducible code.