diff --git a/README.Rmd b/README.Rmd new file mode 100644 index 0000000000000000000000000000000000000000..f055d36cefb280cbfe7e80589b6acc923722ec1a --- /dev/null +++ b/README.Rmd @@ -0,0 +1,118 @@ +# legTools `r readLines("VERSION")` + +[](http://git.leg.ufpr.br/ci/projects/1?ref=master) +Build status for the stable version (`master` branch) + +[](http://git.leg.ufpr.br/ci/projects/1?ref=devel) +Build status for the development version (`devel` branch) + + +An R package containing convenience functions, small GUI to teach +statistics and some datasets. + +## Introduction + +legTools is a collection of R functions and datasets, maintained by the +LEG group (Statistics and Geoinformation Laboratory, *Laboratório de +Estatística e Geoinformação*). + +## Download and install + +### Linux/Mac + +Use the `devtools` package (available from +[CRAN](http://cran-r.c3sl.ufpr.br/web/packages/devtools/index.html)) to +install automatically from this GitLab repository: + +```{r, eval=FALSE} +library(devtools) +install_git("http://git.leg.ufpr.br/leg/legTools.git") +``` + +```{r, echo=FALSE, include=FALSE} +## Get VERSION and create file names +ver <- readLines("VERSION") +pkg.name <- "legTools_" +pkg.source <- paste0(pkg.name, ver, ".tar.gz") +pkg.win <- paste0(pkg.name, ver, ".zip") +``` + +Alternatively, download the package tarball: [`r pkg.source`][] +and run from a UNIX terminal (make sure you are on the container file +directory): + +```{r, echo=FALSE, comment=NA} +cmd <- paste("R CMD INSTALL -l /path/to/your/R/library", pkg.source) +cat(cmd, sep = "\n") +``` + +Or, inside an `R` session: + +```{r, echo=FALSE, comment=NA} +inst <- paste0("install.packages(", "\"", pkg.source, "\"", ", repos = NULL,\n", + " lib.loc = \"/path/to/your/R/library\",\n", + " dependencies = TRUE)") +cat(inst, sep = "\n") +``` + +Note that `-l /path/to/your/R/library` in the former and `lib.loc = +"/path/to/your/R/library"` in the latter are optional. Only use it if +you want to install in a personal library, other than the standard R +library. + +### Windows + +Download Windows binary version: [`r pkg.win`][] (**do not unzip +it under Windows**), put the file in your working directory, and from +inside `R`: + +```{r, echo=FALSE, comment=NA} +instw <- paste0("install.packages(", "\"", pkg.win, "\"", ", repos = NULL,\n", + " dependencies = TRUE)") +cat(instw, sep = "\n") +``` + +### Development version + +By default, if you use `devtools::install_git()`, or download any of the +package tarball or Windows binary version, it will install the stable +version of the package (from the `master` branch of this repository). + +If you want to install the development version, you can use + +```r +library(devtools) +install_git("http://git.leg.ufpr.br/leg/legTools.git", branch = "devel") +``` + +Note that the development version can contain bugs and other unknown +features, so use it at your own risk! + +## Documentation + +The reference manual in PDF can be found here: [legTools-manual.pdf][] + +## Contributing + +This R package is develop using [`roxygen2`][] for documentation and +[`devtools`] to check and build. Also, we adopt the [Gitflow worflow][] +in this repository. Please, see the +[instructions for contributing](./contributing.md) to collaborate. + +## License + +This package is released under the +[GNU General Public License (GPL) v3.0][]. + +See [LICENSE](./LICENSE) + + +<!-- links --> + +[GNU General Public License (GPL) v3.0]: http://www.gnu.org/licenses/gpl-3.0.html +[`roxygen2`]: https://github.com/klutometis/roxygen +[`devtools`]: https://github.com/hadley/devtools +[legTools_0.1.2.tar.gz]: http://www.leg.ufpr.br/~fernandomayer/legTools/legTools_0.1.2.tar.gz +[legTools_0.1.2.zip]: http://www.leg.ufpr.br/~fernandomayer/legTools/legTools_0.1.2.zip +[legTools-manual.pdf]: http://www.leg.ufpr.br/~fernandomayer/legTools/legTools-manual.pdf +[Gitflow worflow]: http://nvie.com/posts/a-successful-git-branching-model/ diff --git a/README.md b/README.md index 2f85db1113f150169380bd8ea917d672f622a801..528c351bcaf886da0e8eb2d1e6238c0063211912 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ -# legTools 0.1.2 +# legTools 0.2.0 + +[](http://git.leg.ufpr.br/ci/projects/1?ref=master) +Build status for the stable version (`master` branch) [](http://git.leg.ufpr.br/ci/projects/1?ref=devel) +Build status for the development version (`devel` branch) + An R package containing convenience functions, small GUI to teach statistics and some datasets. @@ -19,24 +24,29 @@ Use the `devtools` package (available from [CRAN](http://cran-r.c3sl.ufpr.br/web/packages/devtools/index.html)) to install automatically from this GitLab repository: + ```r library(devtools) install_git("http://git.leg.ufpr.br/leg/legTools.git") ``` -Alternatively, download the package tarball: [legTools_0.1.2.tar.gz][] + + +Alternatively, download the package tarball: [legTools_0.2.0.tar.gz][] and run from a UNIX terminal (make sure you are on the container file directory): -```shell -R CMD INSTALL -l /path/to/your/R/library legTools_0.1.2.tar.gz + +``` +R CMD INSTALL -l /path/to/your/R/library legTools_0.2.0.tar.gz ``` Or, inside an `R` session: -```r -install.packages("legTools_0.1.2.tar.gz", repos = NULL, - lib.loc = "/path/to/your/R/library" + +``` +install.packages("legTools_0.2.0.tar.gz", repos = NULL, + lib.loc = "/path/to/your/R/library", dependencies = TRUE) ``` @@ -47,12 +57,13 @@ library. ### Windows -Download Windows binary version: [legTools_0.1.2.zip][] (**do not unzip +Download Windows binary version: [legTools_0.2.0.zip][] (**do not unzip it under Windows**), put the file in your working directory, and from inside `R`: -```r -install.packages("legTools_0.1.2.zip", repos = NULL, + +``` +install.packages("legTools_0.2.0.zip", repos = NULL, dependencies = TRUE) ```