https://github.com/previsionio/prevision-r
https://github.com/previsionio/prevision-r
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/previsionio/prevision-r
- Owner: previsionio
- License: other
- Created: 2020-11-25T18:14:11.000Z (over 5 years ago)
- Default Branch: dev
- Last Pushed: 2022-03-09T10:52:41.000Z (over 4 years ago)
- Last Synced: 2025-07-02T10:50:48.307Z (12 months ago)
- Language: R
- Size: 2.27 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.MD
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
README
# 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()
```