Skip to content

Latest commit

 

History

History
83 lines (65 loc) · 3.06 KB

README.md

File metadata and controls

83 lines (65 loc) · 3.06 KB
Raw

polyclip

Travis-CI Build Status codecov.io CRAN_Status_Badge Research software impact

This repository holds the contributed R-package polyclip, which is an R port of Angus Johnson's library Clipper for polygon clipping.

Version of Clipper Library

This version of polyclip is derived from Clipper1, the original version of the Clipper C++ library, version 6.4.0 [r496] which was obtained from the Sourceforge repository (click Code then Download snapshot). Minor changes have been made to the C++ code to satisfy the requirements for R packages (namely, data type declarations must be portable, and error messages must go through R's error handler).

Note: If your system already includes the polyclipping library (another derivative of clipper) then that version of the library will be used. That is, the R package polyclip will be compiled against the executable library polyclipping on your system, rather than using the bundled source code of clipper 6.4.0 that comes with the polyclip sources.

Installation

The current official release of polyclip is available on CRAN and can be downloaded and installed automatically using the R command install.packages.

The code in this repository is the development version, which may be newer than the official release. The easiest way to install the development version of polyclip from github is through the remotes package:

require(remotes)
install_github('baddstats/polyclip')

If you don't have remotes installed you should first run

install.packages('remotes')

Trouble installing?

When trying to install polyclip, some users get an error message like the following:

    configure: error: in /tmp/Rtmp7967a6f2/polyclip:
    configure: error: C++ compiler cannot create executables
    See config.log for more details
    ERROR: configuration failed for package 'polyclip'

This is a problem with file permissions on your system. If this happens to you, the simplest solution is:

    wget https://cran.r-project.org/src/contrib/polyclip_1.10-7.tar.gz
    tar -zxvf polyclip_1.10-7.tar.gz
    Rscript -e "library('devtools'); devtools::install('polyclip')"

Bug reports

Users of polyclip are encouraged to report bugs here (go to issues in the menu above, and press new issue to start a new bug report or feature request).

Making your own changes

Feel free to fork polyclip, make changes to the code, and ask us to include them in the package by making a github pull request.