aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2014-10-07 07:26:39 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2014-10-07 07:26:39 +0200
commit813b2bba907bf2a62e1d5d58e9f362c09da7dfc1 (patch)
treec824d2c408981d5b212bb7e6a24ae99ba6740939
parent8d7007876dbc01285616817ec261975aa520808c (diff)
Improvements to README, don't run save commands in examples
-rw-r--r--README.md12
-rw-r--r--man/FOCUS_2006_Z_gmkin.Rd6
-rw-r--r--man/FOCUS_2006_gmkin.Rd5
3 files changed, 13 insertions, 10 deletions
diff --git a/README.md b/README.md
index 41bd8ac..8468b6d 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,8 @@ install.packages("gmkin")
This should pull the gmkin package and its dependencies, notably the
gWidgetsWWW2 package which is not available from the CRAN archive (see above).
+Mac users that have the necessary development files installed can probably
+install from the source files in this repository (not tested).
### Keeping it current
@@ -57,12 +59,8 @@ options(repos = c(CRAN = "http://cran.rstudio.com",
gmkin_repo = "http://kinfit.r-forge.r-project.org/repo"))
```
-to your startup options, e.g. to your `.Rprofile` file. Please consult the help
-page for this, e.g. by typing
-
-```s
-?Startup
-```
+to your startup options, e.g. to your `.Rprofile` file. For details, please
+consult the help page for this, e.g. by typing `?Startup` in R.
You can than update your packages including gmkin by using `update.packages()`,
please see its help files for details.
@@ -105,7 +103,7 @@ gmkin()
```
The following screenshot is taken after loading the gmkin workspace with
-an analysis of FOCUS dataset Z. It has to be saved as an .RData file
+an analysis of FOCUS dataset Z. It has to be saved in R as an .RData file
first, and can then be loaded to the GUI.
```s
diff --git a/man/FOCUS_2006_Z_gmkin.Rd b/man/FOCUS_2006_Z_gmkin.Rd
index 4f6a5e4..07f40bb 100644
--- a/man/FOCUS_2006_Z_gmkin.Rd
+++ b/man/FOCUS_2006_Z_gmkin.Rd
@@ -14,8 +14,10 @@
needed to populate the \code{\link{gmkin}} user interface.
}
\examples{
- save(FOCUS_2006_Z_gmkin, file = "FOCUS_2006_gmkin_Z.RData")
- # Now you can load the file "FOCUS_2006_gmkin_Z.RData" from gmkin
+ \dontrun{
+ save(FOCUS_2006_Z_gmkin, file = "FOCUS_2006_Z_gmkin.RData")
+ # Now you can load the file "FOCUS_2006_Z_gmkin.RData" from gmkin
+ }
}
\source{
FOCUS (2006) \dQuote{Guidance Document on Estimating Persistence and
diff --git a/man/FOCUS_2006_gmkin.Rd b/man/FOCUS_2006_gmkin.Rd
index 371ddc7..580286d 100644
--- a/man/FOCUS_2006_gmkin.Rd
+++ b/man/FOCUS_2006_gmkin.Rd
@@ -15,8 +15,11 @@
needed to populate the gmkin user interface.
}
\examples{
+ \dontrun{
save(FOCUS_2006_gmkin, file = "FOCUS_2006_gmkin.RData")
- # Now you can load the file "FOCUS_2006_gmkin.RData" from gmkin
+ # Now you can load the file "FOCUS_2006_gmkin.RData" from gmkin,
+ # restoring the workspace that is loaded at startup.
+ }
}
\source{
FOCUS (2006) \dQuote{Guidance Document on Estimating Persistence and

Contact - Imprint