Reading help functions

classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

Reading help functions

Pedro páramo
Hi all,

I am trying all time to use ?? help function but most of the time it cost
me a lot to understand what they are saying, explaining, there is some
manual to step by step how to interpret help guides in R.

I hope you can understand me because of my english its not the best also.

Many thanks

        [[alternative HTML version deleted]]

______________________________________________
[hidden email] mailing list -- To UNSUBSCRIBE and more, see
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.
Reply | Threaded
Open this post in threaded view
|

Re: Reading help functions

Duncan Murdoch-2
On 22/07/2020 1:20 p.m., Pedro páramo wrote:
> Hi all,
>
> I am trying all time to use ?? help function but most of the time it cost
> me a lot to understand what they are saying, explaining, there is some
> manual to step by step how to interpret help guides in R.
>
> I hope you can understand me because of my english its not the best also.
>

The manuals that come with R give more of an overview than the
individual help pages.  "An Introduction to R" is the basic
introduction.  You should read that first, then go to the help pages
when you need detailed technical information about a particular function.

To see the manuals, run help.start() and click on one of the links near
the top of the page.

If your problems are with help pages from contributed packages, then you
should look for vignettes in the package.  Not all packages have them,
but it's a sign of a lack of interest in documentation if they don't:
and I'd recommend avoiding such packages.

To see the vignettes for "somepackage", run

  browseVignettes(package = "somepackage")

Duncan Murdoch

______________________________________________
[hidden email] mailing list -- To UNSUBSCRIBE and more, see
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.
Reply | Threaded
Open this post in threaded view
|

Re: Reading help functions

Rasmus Liland-3
On 2020-07-22 19:42 -0400, Duncan Murdoch wrote:

> On 22/07/2020 1:20 p.m., Pedro páramo wrote:
> > Hi all,
> >
> > I am trying all time to use ?? help
> > function but most of the time it
> > cost me a lot to understand what
> > they are saying, explaining, there
> > is some manual to step by step how
> > to interpret help guides in R.
> >
> > I hope you can understand me because
> > of my english its not the best
> > also.
>
> The manuals that come with R give more
> of an overview than the individual
> help pages.  "An Introduction to R" is
> the basic introduction.  You should
> read that first, then go to the help
> pages when you need detailed technical
> information about a particular
> function.
>
> To see the manuals, run help.start()
> and click on one of the links near the
> top of the page.
>
> If your problems are with help pages
> from contributed packages, then you
> should look for vignettes in the
> package.  Not all packages have them,
> but it's a sign of a lack of interest
> in documentation if they don't: and
> I'd recommend avoiding such packages.
>
> To see the vignettes for
> "somepackage", run
>
>  browseVignettes(package = "somepackage")
Dear Pedro,

I also use ?? alot.  Recently I found it
really useful to list the functions of a
recently installed package somepackage,
using these to lines:

        library(somepackage)
        ls.str('package:somepackage')

I just put them in a script to run it
quickly in the shell like this:

        #!/usr/bin/env Rscript
        pkg <- commandArgs(trailingOnly=TRUE)[1]
       
        text <-
          paste0("library(",
                 pkg,
                 "); ls.str('package:",
                 pkg,
                 "')")
        eval(parse(text=text))

Best,
Rasmus

______________________________________________
[hidden email] mailing list -- To UNSUBSCRIBE and more, see
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.

signature.asc (849 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Reading help functions

Michael Dewey-3
In reply to this post by Pedro páramo
Dear Pedro

If you prefer reading in Spanish which from your name may be the case
then if you go to CRAN, click on Documentation | Contributed you will
find some documentation in Spanish including several aimed at beginners.
There are some in Portuguese as well if I have mis-interpreted your name.

Of course ultimately you may prefer to read the documents in English
because the program help and vignettes are usually in English and
familiarity with the English terminology may help.

Michael

On 22/07/2020 18:20, Pedro páramo wrote:

> Hi all,
>
> I am trying all time to use ?? help function but most of the time it cost
> me a lot to understand what they are saying, explaining, there is some
> manual to step by step how to interpret help guides in R.
>
> I hope you can understand me because of my english its not the best also.
>
> Many thanks
>
> [[alternative HTML version deleted]]
>
> ______________________________________________
> [hidden email] mailing list -- To UNSUBSCRIBE and more, see
> 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.
>

--
Michael
http://www.dewey.myzen.co.uk/home.html

______________________________________________
[hidden email] mailing list -- To UNSUBSCRIBE and more, see
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.
Reply | Threaded
Open this post in threaded view
|

Re: Reading help functions

Eric Berger
Hi Pedro,
Reading R help pages definitely takes practice.
Here's a tip: when you bring up the help page, scroll down to the bottom to
see if there are examples (there usually are.)
I find that seeing examples often provides enough information to let you
figure out what you need to do.

HTH,
Eric


On Thu, Jul 23, 2020 at 11:33 AM Michael Dewey <[hidden email]>
wrote:

> Dear Pedro
>
> If you prefer reading in Spanish which from your name may be the case
> then if you go to CRAN, click on Documentation | Contributed you will
> find some documentation in Spanish including several aimed at beginners.
> There are some in Portuguese as well if I have mis-interpreted your name.
>
> Of course ultimately you may prefer to read the documents in English
> because the program help and vignettes are usually in English and
> familiarity with the English terminology may help.
>
> Michael
>
> On 22/07/2020 18:20, Pedro páramo wrote:
> > Hi all,
> >
> > I am trying all time to use ?? help function but most of the time it cost
> > me a lot to understand what they are saying, explaining, there is some
> > manual to step by step how to interpret help guides in R.
> >
> > I hope you can understand me because of my english its not the best also.
> >
> > Many thanks
> >
> >       [[alternative HTML version deleted]]
> >
> > ______________________________________________
> > [hidden email] mailing list -- To UNSUBSCRIBE and more, see
> > 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.
> >
>
> --
> Michael
> http://www.dewey.myzen.co.uk/home.html
>
> ______________________________________________
> [hidden email] mailing list -- To UNSUBSCRIBE and more, see
> 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.
>

        [[alternative HTML version deleted]]

______________________________________________
[hidden email] mailing list -- To UNSUBSCRIBE and more, see
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.