Skip to content

Commit

Permalink
Update pkgdown docs and generate README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DavisVaughan committed Jan 3, 2018
1 parent 6d940ad commit 6dec4ab
Show file tree
Hide file tree
Showing 11 changed files with 421 additions and 63 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ Built on top of the `tidyverse`, `tibbletime` is an extension that allows for th

Some immediate advantages of this include:

1. The ability to perform compact time-based subsetting on tibbles.
1. Performing compact time-based subsetting on tibbles.

2. Partitioning an index column by time (like yearly, monthly, every 2 weeks, etc.) so that you can use `dplyr`'s grouped functionality to summarise and aggregate by time period.

3. Changing the periodicity of a time-based tibble. This allows easily changing from a daily dataset to a monthly or yearly dataset.

4. All functions were designed to support the pipe and to work with packages like `dplyr` and `tidyr`. Each function has also been designed to work with `dplyr::group_by()` allowing for powerful data manipulation.
4. Easily working with the pipe and packages like `dplyr` and `tidyr` to make for a seamless experience with time series and the tidyverse. Each function has also been designed to work with `dplyr::group_by()` allowing for powerful data manipulation.

5. Modifying functions for rolling analysis.

6. Quickly creating `tbl_time` time series objects.
6. Creating `tbl_time` time series objects quickly.

7. Full support for `Date` and `POSIXct` index columns, and experimental support for `yearmon`, `yearqtr` and `hms` which should become more stable as some issues in `dplyr` are worked out.
7. Using fully supported `Date` and `POSIXct` index columns, along with experimental support for `yearmon`, `yearqtr` and `hms` which should become more stable as some issues in `dplyr` are worked out.

Installation
------------
Expand Down Expand Up @@ -92,7 +92,7 @@ There are a number of functions that were designed specifically for `tbl_time` o

5. `rollify()` - Modify a function so that it calculates a value (or a set of values) at specific time intervals. This can be used for rolling averages and other rolling calculations inside the `tidyverse` framework.

6. `create_series()` - Use shorthand notation to quickly initialize a `tbl_time` object containing a `date` column with a regularly spaced time series.
6. `create_series()` - Use shorthand notation to quickly initialize a `tbl_time` object containing a regularly spaced index column of class `Date`, `POSIXct`, `yearmon`, `yearqtr` or `hms`.

To look at just a few:

Expand Down Expand Up @@ -201,7 +201,7 @@ create_series(~'2013', '2 day')
Grouping
--------

Groups created through `dplyr::group_by()` are supported throughout the package. Because `collapse_index()` is just adding a column you can group on, all dplyr functions are supported.
Groups created through `dplyr::group_by()` are supported throughout the package. Because `collapse_index()` is just adding a column you can group on, all `dplyr` functions are supported.

``` r
# Facebook, Amazon, Netflix and Google stocks
Expand Down
2 changes: 1 addition & 1 deletion docs/articles/TT-01-time-based-filtering.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/articles/TT-02-changing-time-periods.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/articles/TT-03-rollify-for-rolling-analysis.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

91 changes: 46 additions & 45 deletions docs/articles/TT-04-use-with-dplyr.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/articles/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions docs/news/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 13 additions & 1 deletion docs/reference/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 6dec4ab

Please sign in to comment.