diff --git a/.Rbuildignore b/.Rbuildignore index dbd5910..d70a7e2 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -5,3 +5,6 @@ ^LICENSE\.md$ ^README\.Rmd$ ^\.github$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/.gitignore b/.gitignore index cd67eac..513025f 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ .Rproj.user +docs diff --git a/DESCRIPTION b/DESCRIPTION index 5260ca0..74f473a 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,11 +1,18 @@ Package: sequentially -Title: What the Package Does (One Line, Title Case) +Title: An R package for non-linear sequence generation using easing functions Version: 0.0.0.9000 Authors@R: - person("First", "Last", , "first.last@example.com", role = c("aut", "cre"), - comment = c(ORCID = "YOUR-ORCID-ID")) -Description: What the package does (one paragraph). + person("JP", "Monteagudo", + email = "jpmonteagudo2014@gmail.com", + role = c("aut", "cre","cph"), + comment = c(ORCID = "0009-0003-6465-6658")) +Description: This package is born out of curiosity rather than necessity. 'sequentially' creates non-linear and linear numeric sequences. By using non-linear interpolation the user can animate their data +in a way that is more visually pleasing than uniform, linear interpolation. The functions in this package could be used in data visualization, +motion animation, frame interpolation, UI/UX design, population dynamics, economics and finance. License: GPL (>= 3) Encoding: UTF-8 Roxygen: list(markdown = TRUE) RoxygenNote: 7.3.2 +URL: https://github.com/jpmonteagudo28/sequentially +Issues: https://github.com/jpmonteagudo28/sequentially/issues + diff --git a/README.Rmd b/README.Rmd index aedf926..91aec94 100644 --- a/README.Rmd +++ b/README.Rmd @@ -11,32 +11,44 @@ knitr::opts_chunk$set( fig.path = "man/figures/README-", out.width = "100%" ) + +#library(sequentially) ``` -# sequentially +# sequentially + +![](https://img.shields.io/badge/fun_but_useless-%23035949) [![CRAN status](https://www.r-pkg.org/badges/version/sequentially)](https://CRAN.R-project.org/package=sequentially) [![stability-wip](https://img.shields.io/badge/stability-wip-lightgrey.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#work-in-progress) -The goal of sequentially is to ... +This package is born out of curiosity rather than necessity. `sequentially` creates non-linear and linear numeric sequences. By using non-linear interpolation the user can animate their data +in a way that is more visually pleasing than uniform, linear interpolation. The functions in this package represent a break from the **essential** but *boring* `seq()` family of functions–I wanted to plot numeric sequences could be used in data visualization, motion animation, frame interpolation, UI/UX design, population dynamics, economics and finance. ## Installation You can install the development version of sequentially like so: ``` r -# FILL THIS IN! HOW CAN PEOPLE INSTALL YOUR DEV PACKAGE? +devtools::install_github("sequentially") +``` + +or download it from CRAN: + +```r +install.packages("sequentially") ``` -## Example + +## What you get: This is a basic example which shows you how to solve a common problem: ```{r example} -library(sequentially) +# library(sequentially) ## basic example code ``` @@ -54,4 +66,7 @@ You can also embed plots, for example: ``` -In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN. +## Related Software +* [tweenr](https://cran.r-project.org/web/packages/tweenr/tweenr.pdf) - an R package dealing with data animation. +* [displease](https://github.com/coolbutuseless/displease) - a related package used as inspiration for this one. +* [ofpennereasing](https://github.com/jesusgollonet/ofpennereasing) - Rcpp files containing Robert Penner's easing functions diff --git a/README.md b/README.md new file mode 100644 index 0000000..2ca3da4 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ + + + +# sequentially + + + +![](https://img.shields.io/badge/fun_but_useless-%23035949) [![CRAN +status](https://www.r-pkg.org/badges/version/sequentially)](https://CRAN.R-project.org/package=sequentially) +[![stability-wip](https://img.shields.io/badge/stability-wip-lightgrey.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#work-in-progress) + + + +This package is born out of curiosity rather than necessity. +`sequentially` creates non-linear and linear numeric sequences. By using +non-linear interpolation the user can animate their data in a way that +is more visually pleasing than uniform, linear interpolation. The +functions in this package represent a break from the **essential** but +*boring* `seq()` family of functions–I wanted to plot numeric sequences +could be used in data visualization, motion animation, frame +interpolation, UI/UX design, population dynamics, economics and finance. + +## Installation + +You can install the development version of sequentially like so: + +``` r +devtools::install_github("sequentially") +``` + +or download it from CRAN: + +``` r +install.packages("sequentially") +``` + +## What you get: + +This is a basic example which shows you how to solve a common problem: + +``` r +# library(sequentially) +## basic example code +``` + +What is special about using `README.Rmd` instead of just `README.md`? +You can include R chunks like so: + +You’ll still need to render `README.Rmd` regularly, to keep `README.md` +up-to-date. `devtools::build_readme()` is handy for this. + +You can also embed plots, for example: + +## Related Software + +- [tweenr](https://cran.r-project.org/web/packages/tweenr/tweenr.pdf) - + an R package dealing with data animation. +- [displease](https://github.com/coolbutuseless/displease) - a related + package used as inspiration for this one. +- [ofpennereasing](https://github.com/jesusgollonet/ofpennereasing) - + Rcpp files containing Robert Penner’s easing functions diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..73c7560 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,22 @@ +url: https://sequentially.jpmonteagudo.com + +template: + bootstrap: 5 + bslib: + bg: "#5697BF" + fg: "#035949" + primary: "#53075B" + base_font: {google: "Libre Franklin Light"} + heading_font: {google: "Montserrat Alternates"} + code_font: {google: "Fira Code"} + theme: a11y-light + + navbar: + bg: primary + structure: + left: [intro, get started,reference, news] + right: [search,github] + footer: + structure: + left: developed_by + right: built_with diff --git a/man/figures/logo.png b/man/figures/logo.png new file mode 100644 index 0000000..842bcd6 Binary files /dev/null and b/man/figures/logo.png differ diff --git a/man/logo.png b/man/logo.png new file mode 100644 index 0000000..26b5883 Binary files /dev/null and b/man/logo.png differ