Skip to content

Commit 0d0a7ad

Browse files
committed
mention the metadata attributes in the vignette
1 parent cf45a6c commit 0d0a7ad

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

vignettes/metadata.Rmd

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ This function allows you to add or update the optional metadata of a `git2rdata`
8181
Setting an argument to `NA` or an empty string will remove the corresponding property from the metadata.
8282
The function only updates the metadata file, not the data file.
8383
To see the changes, read the object again before using `display_metadata()`.
84+
Note that all the metadata is available in the `data.frame` as attributes.
8485

8586
```{r update-metadata}
8687
update_metadata(
@@ -97,6 +98,8 @@ measurements in taxonomic problems.",
9798
Species = "The species of the iris"
9899
)
99100
)
100-
display_metadata(read_vc("iris", root = root))
101+
my_iris <- read_vc("iris", root = root)
102+
display_metadata(my_iris)
103+
str(my_iris)
101104
```
102105

0 commit comments

Comments
 (0)