Merge pull request #943 from tidyverse/docs-trees

- Replace `iris` by `trees` (#943).

Author: krlmlr

NEWS.md

@@ -212,7 +212,7 @@
 
 ## Breaking changes
 
-- `tibble()` now splices anonymous data frames, `tibble(tibble(a = 1), b = a)` is equivalent to `tibble(a = 1, b = a)`. This means that `tibble(iris)` now has five columns, use `tibble(iris = iris)` if the intention is to create a packed data frame (#581).
+- `tibble()` now splices anonymous data frames, `tibble(tibble(a = 1), b = a)` is equivalent to `tibble(a = 1, b = a)`. This means that `tibble(trees)` now has three columns, use `tibble(trees = trees)` if the intention is to create a packed data frame (#581).
 
 - The `name-repair` help topic is gone, refer to `?vctrs::vec_as_names` instead.
 

R/new.R

@@ -27,7 +27,7 @@
 #' new_tibble(list(a = 1:3, b = 4:6), nrow = 3)
 #'
 #' # Existing row.names attributes are ignored:
-#' try(validate_tibble(new_tibble(iris, nrow = 3)))
+#' try(validate_tibble(new_tibble(trees, nrow = 3)))
 #'
 #' # The length of all columns must be compatible with the nrow argument:
 #' try(validate_tibble(new_tibble(list(a = 1:3, b = 4:6), nrow = 2)))

R/print.R

@@ -43,7 +43,7 @@
 #' print(as_tibble(mtcars), n = 1)
 #' print(as_tibble(mtcars), n = 3)
 #'
-#' print(as_tibble(iris), n = 100)
+#' print(as_tibble(trees), n = 100)
 #'
 #' print(mtcars, width = 10)
 #'

R/rownames.R

@@ -25,7 +25,7 @@
 #' @examples
 #' # Detect row names ----------------------------------------------------
 #' has_rownames(mtcars)
-#' has_rownames(iris)
+#' has_rownames(trees)
 #'
 #' # Remove row names ----------------------------------------------------
 #' remove_rownames(mtcars) %>% has_rownames()
@@ -36,7 +36,7 @@
 #' column_to_rownames(mtcars_tbl, var = "car") %>% head()
 #'
 #' # Adding rowid as a column --------------------------------------------
-#' rowid_to_column(iris) %>% head()
+#' rowid_to_column(trees) %>% head()
 #'
 #' @name rownames
 NULL

R/tibble.R

@@ -121,9 +121,9 @@
 #'   )
 #' )
 #' tibble(
-#'   a = 1:4,
-#'   b = diag(4),
-#'   c = cov(iris[1:4])
+#'   a = 1:3,
+#'   b = diag(3),
+#'   c = cor(trees)
 #' )
 #'
 #' # data can not contain POSIXlt columns, or tibbles or matrices
@@ -163,7 +163,7 @@ tibble <- function(...,
 #' @examples
 #'
 #' # Use tibble_row() to construct a one-row tibble:
-#' tibble_row(a = 1, lm = lm(Petal.Width ~ Petal.Length + Species, data = iris))
+#' tibble_row(a = 1, lm = lm(Height ~ Girth + Volume, data = trees))
 tibble_row <- function(...,
                        .name_repair = c("check_unique", "unique", "universal", "minimal")) {
   xs <- enquos(...)

README.Rmd

@@ -43,11 +43,17 @@ devtools::install_github("tidyverse/tibble")
 
 ## Usage
 
+```{r}
+library(tibble)
+```
+
 Create a tibble from an existing object with `as_tibble()`:
 
 ```{r}
-library(tibble)
-as_tibble(iris)
+data <- data.frame(a = 1:3, b = letters[1:3], c = Sys.Date() - 1:3)
+data
+
+as_tibble(data)
 ```
 
 This will work for reasonable inputs that are already data.frames, lists, matrices, or tables.

README.md

@@ -29,25 +29,26 @@ If you are new to tibbles, the best place to start is the [tibbles chapter](http
 
 ## Usage
 
+<pre class='chroma'>
+<span class='kr'><a href='https://rdrr.io/r/base/library.html'>library</a></span><span class='o'>(</span><span class='nv'><a href='https://tibble.tidyverse.org/'>tibble</a></span><span class='o'>)</span></pre>
+
 Create a tibble from an existing object with [`as_tibble()`](https://tibble.tidyverse.org/reference/as_tibble.html):
 
 <pre class='chroma'>
-<span class='kr'><a href='https://rdrr.io/r/base/library.html'>library</a></span><span class='o'>(</span><span class='nv'><a href='https://tibble.tidyverse.org/'>tibble</a></span><span class='o'>)</span>
-<span class='nf'><a href='https://tibble.tidyverse.org/reference/as_tibble.html'>as_tibble</a></span><span class='o'>(</span><span class='nv'>iris</span><span class='o'>)</span>
-<span class='c'>#&gt; <span style='color: #555555;'># A tibble: 150 × 5</span></span>
-<span class='c'>#&gt;    <span style='font-weight: bold;'>Sepal.Length</span> <span style='font-weight: bold;'>Sepal.Width</span> <span style='font-weight: bold;'>Petal.Length</span> <span style='font-weight: bold;'>Petal.Width</span> <span style='font-weight: bold;'>Species</span></span>
-<span class='c'>#&gt;           <span style='color: #555555; font-style: italic;'>&lt;dbl&gt;</span>       <span style='color: #555555; font-style: italic;'>&lt;dbl&gt;</span>        <span style='color: #555555; font-style: italic;'>&lt;dbl&gt;</span>       <span style='color: #555555; font-style: italic;'>&lt;dbl&gt;</span> <span style='color: #555555; font-style: italic;'>&lt;fct&gt;</span>  </span>
-<span class='c'>#&gt; <span style='color: #555555;'> 1</span>          5.1         3.5          1.4         0.2 setosa </span>
-<span class='c'>#&gt; <span style='color: #555555;'> 2</span>          4.9         3            1.4         0.2 setosa </span>
-<span class='c'>#&gt; <span style='color: #555555;'> 3</span>          4.7         3.2          1.3         0.2 setosa </span>
-<span class='c'>#&gt; <span style='color: #555555;'> 4</span>          4.6         3.1          1.5         0.2 setosa </span>
-<span class='c'>#&gt; <span style='color: #555555;'> 5</span>          5           3.6          1.4         0.2 setosa </span>
-<span class='c'>#&gt; <span style='color: #555555;'> 6</span>          5.4         3.9          1.7         0.4 setosa </span>
-<span class='c'>#&gt; <span style='color: #555555;'> 7</span>          4.6         3.4          1.4         0.3 setosa </span>
-<span class='c'>#&gt; <span style='color: #555555;'> 8</span>          5           3.4          1.5         0.2 setosa </span>
-<span class='c'>#&gt; <span style='color: #555555;'> 9</span>          4.4         2.9          1.4         0.2 setosa </span>
-<span class='c'>#&gt; <span style='color: #555555;'>10</span>          4.9         3.1          1.5         0.1 setosa </span>
-<span class='c'>#&gt; <span style='color: #555555;'># … with 140 more rows</span></span></pre>
+<span class='nv'>data</span> <span class='o'>&lt;-</span> <span class='nf'><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a></span><span class='o'>(</span>a <span class='o'>=</span> <span class='m'>1</span><span class='o'>:</span><span class='m'>3</span>, b <span class='o'>=</span> <span class='nv'>letters</span><span class='o'>[</span><span class='m'>1</span><span class='o'>:</span><span class='m'>3</span><span class='o'>]</span>, c <span class='o'>=</span> <span class='nf'><a href='https://rdrr.io/r/base/Sys.time.html'>Sys.Date</a></span><span class='o'>(</span><span class='o'>)</span> <span class='o'>-</span> <span class='m'>1</span><span class='o'>:</span><span class='m'>3</span><span class='o'>)</span>
+<span class='nv'>data</span>
+<span class='c'>#&gt;   a b          c</span>
+<span class='c'>#&gt; 1 1 a 2021-07-31</span>
+<span class='c'>#&gt; 2 2 b 2021-07-30</span>
+<span class='c'>#&gt; 3 3 c 2021-07-29</span>
+
+<span class='nf'><a href='https://tibble.tidyverse.org/reference/as_tibble.html'>as_tibble</a></span><span class='o'>(</span><span class='nv'>data</span><span class='o'>)</span>
+<span class='c'>#&gt; <span style='color: #555555;'># A tibble: 3 × 3</span></span>
+<span class='c'>#&gt;       <span style='font-weight: bold;'>a</span> <span style='font-weight: bold;'>b</span>     <span style='font-weight: bold;'>c</span>         </span>
+<span class='c'>#&gt;   <span style='color: #555555; font-style: italic;'>&lt;int&gt;</span> <span style='color: #555555; font-style: italic;'>&lt;chr&gt;</span> <span style='color: #555555; font-style: italic;'>&lt;date&gt;</span>    </span>
+<span class='c'>#&gt; <span style='color: #555555;'>1</span>     1 a     2021-07-31</span>
+<span class='c'>#&gt; <span style='color: #555555;'>2</span>     2 b     2021-07-30</span>
+<span class='c'>#&gt; <span style='color: #555555;'>3</span>     3 c     2021-07-29</span></pre>
 
 This will work for reasonable inputs that are already data.frames, lists, matrices, or tables.