Skip to content

Commit

Permalink
working on Readme and website
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmonteagudo28 committed Dec 5, 2024
1 parent 876552d commit 80c7c5c
Show file tree
Hide file tree
Showing 8 changed files with 119 additions and 10 deletions.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@
^LICENSE\.md$
^README\.Rmd$
^\.github$
^_pkgdown\.yml$
^docs$
^pkgdown$
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.Rproj.user
docs
15 changes: 11 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -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", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "YOUR-ORCID-ID"))
Description: What the package does (one paragraph).
person("JP", "Monteagudo",
email = "[email protected]",
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

27 changes: 21 additions & 6 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,32 +11,44 @@ knitr::opts_chunk$set(
fig.path = "man/figures/README-",
out.width = "100%"
)
#library(sequentially)
```

# sequentially
# sequentially <img src="man/figures/logo.png" align="right" height="195" alt="" />


<!-- badges: start -->
![](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)

<!-- badges: end -->

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
```

Expand All @@ -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
61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# sequentially <img src="man/figures/logo.png" align="right" height="195" alt="" />

<!-- badges: start -->

![](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)

<!-- badges: end -->

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
22 changes: 22 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -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
Binary file added man/figures/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added man/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 80c7c5c

Please sign in to comment.