readme.MD

In previsionio/prevision-r: 'Prevision.io' R SDK

Installing package

git clone https://bitbucket.org/previsionio/previsionio-r
R CMD build previsionio-r
R CMD INSTALL previsionio_11.7.0.tar.gz

Using package

library(previsionio)

Building Documentation

1) To generate Doxygen documentation All the functions are commented directly in the code. The following lines generate a new folder " man " in the R project. In Rstudio, type :

library(roxygen2)
library(devtools)
document()

2) To generate automatically the documentation in pdf. In the terminal, in the directory where the project is, type :

R CMD Rd2pdf --pdf --title='R package for Prevision.io' -o /tmp/previsionio.pdf man/*.Rd

If you find trouble doing so on windows, make sure that MiKTeX is installed & updated See : https://tex.stackexchange.com/questions/125274/error-font-ts1-zi4r-at-540-not-found if you encounter a font issue

3) In order to check if package is viable on CRAN, type :

devtools::check()

previsionio/prevision-r documentation built on March 24, 2022, 1:28 a.m.