Monday, September 29, 2014

HELP!!!! files

We know, we know....  We said that we were going to talk about using R in the classroom for a while, but we just couldn't resist sharing something small, but exciting in SSDforR.

First, if you have already installed SSDforR, be sure to download the latest version, 1.4.7, from CRAN.  We have updated the help files in a small, but useful way.  Let us show you what we mean.....

To get to the help files, you really have three choices once you require the package by clicking on the box next to SSDforR in the Packages tab:

1)  In the Console, type ?SSDforR at the prompt.  You will be taken here:



If you click on the Index hyperlink (see the arrow above), you will be taken to a page showing all the help files.  It looks like this:


Now click on the hyperlink for the function you want. 

2)  You can also simply click on the SSDforR hyperlink in the Packages tab:


 You will then be taken to the help file screen, shown above.

3)  If you know the function you want specific help for, simply type "?" followed by the function in the Console.  For example, if you want help with the ABrf2 function, simply enter:  ?ABrf2.

 ******
Now, here's our help file reveal that will, hopefully, make your lives easier.....


In the references section, for each function, we inserted ALL the pages from our book that refer to that particular function. 

What does that mean and how will that help you?

Now, you will have in-depth descriptions of each function, an explanation of when you would want to use the function,  how you would interpret your findings, and a contextual example.

As an example, let's look at the ABrf2 function.  Notice that the listed pages in the help file are clustered around pages 37-41 and 65-66.  When you refer to those pages in our text, you find a more comprehensive discussion of autocorrelation and related functions.  We also provide, in these pages, multiple examples of how we would interpret findings from this function.  When is autocorrelation problematic?  Why is it problematic?  Could I somehow rid my data of this dreadful condition?

You get the point.....

Check it out, and let us know how well this works for you!  Feel free to email us, comment on this post, and, of course, continue to check out our website:  www.ssdanalysis.com


No comments:

Post a Comment