Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A pkgdown website for data.table #3677

Merged
merged 62 commits into from
Sep 16, 2019
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
62 commits
Select commit Hold shift + click to select a range
d6b0eee
Flag deprecated set2key as internal
hadley Jul 1, 2019
91d654e
First pass at organisation documentation topics into sections
hadley Jul 1, 2019
4b9fa21
Add github url to URL
hadley Jul 1, 2019
2071079
Use h1 and h2 in NEWS
hadley Jul 1, 2019
fa012ea
gitignore website
hadley Jul 1, 2019
37969d9
Rough first pass at readme/homepage
hadley Jul 3, 2019
58227b1
pass at improving ref index & fine-tuning homepage
Jul 4, 2019
47251a5
fix invalid yaml
jangorecki Aug 26, 2019
99aec2c
README simplify, use md for pkgdown(devel=F)
jangorecki Aug 26, 2019
786521b
use GH URL in dcf for pkgdown
jangorecki Aug 26, 2019
c3a911a
try render pkgdown
jangorecki Aug 26, 2019
d5ce7cf
build ignore pkgdown yml
jangorecki Aug 26, 2019
134ea33
script 0 note check, allow failure for pkgdown dev
jangorecki Aug 26, 2019
cf51185
pkgdown allow to publish
jangorecki Aug 26, 2019
9f586eb
plan pkgdown navbar
jangorecki Aug 26, 2019
5b68577
install pkgdown dependencies
jangorecki Aug 26, 2019
c23cf1d
proper install libxml2-dev for pkgdown
jangorecki Aug 26, 2019
bcd8d82
Merge branch 'master' into pkgdown
jangorecki Aug 26, 2019
41a5a2f
pkgdown devel=FALSE needs dt to be installed
jangorecki Aug 26, 2019
8746978
no need to ignnore, pkgdown runs in CI, not manually
jangorecki Aug 27, 2019
bc16fa3
align NEWS.0.md style to NEWS.md for pkgdown req
jangorecki Aug 27, 2019
ee5a45f
I dont think we need to ignore png here, one is already there
jangorecki Aug 27, 2019
b4bd2a7
CI install pkgs quiet
jangorecki Aug 27, 2019
db08909
after rmerge recent master does not fail anymore, disallow failure
jangorecki Aug 27, 2019
2860cbe
compiler flag _g_ should be disabled by default already
jangorecki Aug 27, 2019
5fe9298
Merge branch 'master' into pkgdown
jangorecki Aug 27, 2019
25b6aa0
tweak README accordiing to feedback
jangorecki Aug 27, 2019
307a76f
rename to more R-ish label
jangorecki Aug 27, 2019
152c9bd
depsy in unmaintainedand outdated, remove badge
jangorecki Aug 27, 2019
a998287
try https svg ref
jangorecki Aug 27, 2019
a0c5a6f
address as-cran NOTE abt pkg size, new images dont need to be in pkg …
jangorecki Aug 27, 2019
0c8260f
Usage of SD vignette cleanup to reduce pkg size
jangorecki Aug 27, 2019
e85ea0b
compiler flag _g_ IS NOT disabled by default
jangorecki Aug 27, 2019
881a4b5
add missing png to homepage
jangorecki Aug 27, 2019
1b4ccde
pkg size resolved, no more CRAN note, disallow failure
jangorecki Aug 27, 2019
cd89d39
add custom version tooltip
Aug 27, 2019
7cef6a4
Merge branch 'master' into pkgdown
Aug 27, 2019
dbe165b
Merge branch 'master' into pkgdown
jangorecki Aug 28, 2019
e51a2d2
version label always dev
jangorecki Aug 28, 2019
e01d704
inform in case of files overwritten by pkgdown
jangorecki Aug 28, 2019
f5227db
fix missing figures in vignette
jangorecki Aug 28, 2019
c921902
remove cformatting from title
jangorecki Aug 28, 2019
d42468a
align NEWS.md to pkgdown expected structure
jangorecki Aug 28, 2019
295e845
group manuals
jangorecki Aug 28, 2019
b7113e2
Merge branch 'master' into pkgdown
jangorecki Aug 29, 2019
ee0bb43
fix SD vign pkgdown missing plots
jangorecki Aug 29, 2019
6b0cc61
pkgdown manual fix warns
jangorecki Aug 29, 2019
34bbc7d
Merge branch 'master' into pkgdown
jangorecki Aug 29, 2019
f7615e1
add revdeps badges
jangorecki Aug 29, 2019
2046ee8
pkgdown now installs from root dir so need it clean, reorder tasks in…
jangorecki Aug 29, 2019
f0bb36f
add missing manual, reorder
jangorecki Aug 29, 2019
6e450a1
add depsy badge
jangorecki Aug 29, 2019
bef735e
Merge branch 'master' into pkgdown
jangorecki Aug 30, 2019
568cce4
mention copy in another section of manual
jangorecki Aug 30, 2019
6b99855
add GA tag
jangorecki Aug 30, 2019
2887991
Merge branch 'master' into pkgdown
jangorecki Sep 1, 2019
d9ce464
Merge branch 'master' into pkgdown
jangorecki Sep 4, 2019
a04c593
Merge branch 'master' into pkgdown
jangorecki Sep 6, 2019
f89acfc
rename coalesce to fcoalesce in pkgdown manual index
jangorecki Sep 6, 2019
ea7db96
use two urls again in desc file
jangorecki Sep 16, 2019
7e0e6a5
Merge branch 'master' into pkgdown
jangorecki Sep 16, 2019
7b361bf
Merge branch 'master' into pkgdown
jangorecki Sep 16, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,6 @@ vignettes/*.pdf
.DS_Store
.idea
*.sw[op]

# built website
docs
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Suggests: bit64, curl, R.utils, knitr, xts, nanotime, zoo, yaml
SystemRequirements: zlib
Description: Fast aggregation of large data (e.g. 100GB in RAM), fast ordered joins, fast add/modify/delete of columns by group using no copies at all, list columns, friendly and fast character-separated-value read/write. Offers a natural and flexible syntax, for faster development.
License: MPL-2.0 | file LICENSE
URL: http://r-datatable.com
URL: http://r-datatable.com, https:/Rdatatable/data.table
BugReports: https:/Rdatatable/data.table/issues
VignetteBuilder: knitr
ByteCompile: TRUE
80 changes: 40 additions & 40 deletions NEWS.md

Large diffs are not rendered by default.

41 changes: 41 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
output: github_document
---

# data.table <a href="http://r-datatable.com"><img src="man/figures/logo.png" align="right" height="140" /></a>

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/data.table)](https://cran.r-project.org/package=data.table)
[![Travis build status](https://travis-ci.org/Rdatatable/data.table.svg?branch=master)](https://travis-ci.org/hadley/data.table)
[![Codecov test coverage](https://codecov.io/gh/Rdatatable/data.table/branch/master/graph/badge.svg)](https://codecov.io/gh/hadley/data.table?branch=master)
<!-- badges: end -->

data.table provides a high-performance and programmer-friendly version of R's `data.frame`. It makes it easy to perform grouped summaries and perform flexible joins (including ordered, rolling, and overlapping range joins), and is optimised for high-performance on large data sets, using parallelism and indices to make code as fast as possible. data.table has no external dependencies and relies only on R 3.1.0, making it well suited for use in production.

data.table also includes `fread()` for fast and friendly file reading, `fwrite()` for fast file writing, and a collection of functions for fast and convenient vectorised operations including `frank()`, `froll()`, and `forder()`.

data.table is widely used by the R community. As of July 2019, it was used by over 680 CRAN and Bioconductor packages and was the [9th most starred](http://www.r-pkg.org/starred) R package on GitHub. If you need help, the data.table community is active StackOverflow, with nearly [9,000 questions](http://stackoverflow.com/questions/tagged/data.table).

## Installation

You can install the released version of data.table from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("data.table")
```

See [the data.table wiki](https:/Rdatatable/data.table/wiki/Installation) for instructions on installing the development version.

## Cheatsheets

<a href="https:/rstudio/cheatsheets/raw/master/datatable.pdf"><img src="man/figures/cheatsheet.png" width="615" height="242"/></a>

## Example

This is a basic example which shows you how to solve a common problem:

``` r
library(data.table)
## basic example code
```

57 changes: 56 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,57 @@

### Overview is on the project's [homepage](http://r-datatable.com).
# data.table <a href="http://r-datatable.com"><img src="man/figures/logo.png" align="right" height="140" /></a>

<!-- badges: start -->

[![CRAN
status](https://www.r-pkg.org/badges/version/data.table)](https://cran.r-project.org/package=data.table)
[![Travis build
status](https://travis-ci.org/Rdatatable/data.table.svg?branch=master)](https://travis-ci.org/hadley/data.table)
[![Codecov test
coverage](https://codecov.io/gh/Rdatatable/data.table/branch/master/graph/badge.svg)](https://codecov.io/gh/hadley/data.table?branch=master)
<!-- badges: end -->

data.table provides a high-performance and programmer-friendly version
of R’s `data.frame`. It makes it easy to perform grouped summaries and
perform flexible joins (including ordered, rolling, and overlapping
range joins), and is optimised for high-performance on large data sets,
using parallelism and indices to make code as fast as possible.
data.table has no external dependencies and relies only on R 3.1.0,
making it well suited for use in production.

data.table also includes `fread()` for fast and friendly file reading,
`fwrite()` for fast file writing, and a collection of functions for fast
and convenient vectorised operations including `frank()`, `froll()`, and
`forder()`.

data.table is widely used by the R community. As of July 2019, it was
used by over 680 CRAN and Bioconductor packages and was the [9th most
starred](http://www.r-pkg.org/starred) R package on GitHub. If you need
help, the data.table community is active StackOverflow, with nearly
[9,000 questions](http://stackoverflow.com/questions/tagged/data.table).

## Installation

You can install the released version of data.table from
[CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("data.table")
```

See [the data.table
wiki](https:/Rdatatable/data.table/wiki/Installation) for
instructions on installing the development version.

## Cheatsheets

<a href="https:/rstudio/cheatsheets/raw/master/datatable.pdf"><img src="man/figures/cheatsheet.png" width="615" height="242"/></a>

## Example

This is a basic example which shows you how to solve a common problem:

``` r
library(data.table)
## basic example code
```
89 changes: 89 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
destination: docs

# url: http://r-datatable.com

home:
links:
- text: Watch presentations
href: https:/Rdatatable/data.table/wiki/Presentations
- text: Read articles
href: https:/Rdatatable/data.table/wiki/Articles

reference:
- title: Core
contents:
- data.table
- '`special-symbols`'
- J
- patterns
- as.data.table
- print.data.table
- fread
- fwrite
- rbindlist

- title: Functions that work with complete tables
contents:
- all.equal.data.table
- as.matrix.data.table
- as.xts.data.table
- dcast
- duplicated.data.table
- fintersect
- melt.data.table
- merge.data.table
- na.omit.data.table
- split.data.table
- subset.data.table
- transform.data.table

- title: Grouping and keys
contents:
- rowid
- groupingsets
- setkey

- title: Functions that work with vectors
contents:
- between
- chmatch
- coalesce
- first
- foverlaps
- frank
- frollmean
- fsort
- last
- like
- nafill
- rleid
- shift
- transpose
- tstrsplit

- title: Efficient in-place modification
contents:
- set
- setattr
- setDF
- setDT
- setcolorder
- setnames
- setorder

- title: Advanced/Miscellaneous
contents:
- .Last.updated
- address
- copy
- '`data.table-class`'
- datatable.optimize
- IDateTime
- setDTthreads
- setNumericRounding
- shouldPrint
- tables
- test.data.table
- timetaken
- truelength
- update.dev.pkg
Binary file added man/figures/cheatsheet.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/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.
1 change: 1 addition & 0 deletions man/set2key.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
\alias{key2}
\alias{key<-}
\title{ Deprecated. }
\keyword{internal}
MichaelChirico marked this conversation as resolved.
Show resolved Hide resolved
\description{
These functions are deprecated. They will be removed in future. Please use the functions in \code{\link{setkey}}.
}
Expand Down
1 change: 1 addition & 0 deletions vignettes/plots/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.png