directlabels

directlabels copied to clipboard

[[./logos/directlabels logo (orange).png]] #+BEGIN_HTML

** Installation from CRAN

#+BEGIN_SRC R install.packages("directlabels") #+END_SRC

** Install development version from GitHub

Development of directlabels on R-Forge stopped on 16 June 2015. Please install the development version from GitHub instead:

#+BEGIN_SRC R if(!require(devtools))install.packages("devtools") devtools::install_github("tdhock/directlabels") #+END_SRC

Changes are listed in [[file:NEWS]].

** Usage examples

Please check [[https://tdhock.github.io/directlabels/docs/index.html][the documentation page]] (with links to examples for specific methods) and [[https://tdhock.github.io/directlabels/examples.html][the page with several advanced examples]].

** Development and documentation

Documentation in [[file:R/][R/.R]] files is used to make [[file:man/][man/.Rd]] files using [[https://github.com/tdhock/inlinedocs][inlinedocs]]:

#+BEGIN_SRC R devtools::install_github("tdhock/inlinedocs") inlinedocs::package.skeleton.dx("path/to/directlabels") #+END_SRC

The [[https://tdhock.github.io/directlabels/docs/index.html][directlabels documentation examples site]] can be generated via the [[https://github.com/tdhock/directlabels/tree/gh-pages][gh-pages]] branch by using:

#+BEGIN_SRC R directlabels::dldoc("path/to/directlabels") #+END_SRC

Be careful about what you put in each of the R code files -- they are used to generate the documentation. For example, [[file:R/dotplot.R][R/dotplot.R]] defines just two R objects: angled.endpoints and top.qp. Don't add anything to this file unless you want it to show up in the docs as another Positioning Method for dotplots. Miscellaneous functions that could be helpful for constructing Positioning Methods should be put in [[file:R/utility.function.R][R/utility.function.R]].