https://github.com/uncoast-unconf/steward
Helps you manage metadata for published datasets
https://github.com/uncoast-unconf/steward
Last synced: 3 months ago
JSON representation
Helps you manage metadata for published datasets
- Host: GitHub
- URL: https://github.com/uncoast-unconf/steward
- Owner: uncoast-unconf
- License: other
- Created: 2019-03-23T20:33:15.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-11T22:35:33.000Z (almost 4 years ago)
- Last Synced: 2025-01-20T02:08:50.107Z (3 months ago)
- Language: R
- Homepage: https://uncoast-unconf.github.io/steward/
- Size: 354 KB
- Stars: 11
- Watchers: 5
- Forks: 6
- Open Issues: 28
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - uncoast-unconf/steward - Helps you manage metadata for published datasets (R)
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = FALSE,
comment = "",
fig.path = "man/figures/README-",
out.width = "100%"
)
# https://community.rstudio.com/t/showing-only-the-first-few-lines-of-the-results-of-a-code-chunk/6963/2
#
hook_output <- knitr::knit_hooks$get("output")
knitr::knit_hooks$set(
output = function(x, options) {
lines <- options$output.lines
if (is.null(lines)) {
return(hook_output(x, options)) # pass to default hook
}
x <- unlist(strsplit(x, "\n"))
more <- "..."
if (length(lines)==1) { # first n lines
if (length(x) > lines) {
# truncate the output, but add ....
x <- c(head(x, lines), more)
}
} else {
x <- c(more, x[lines], more)
}
# paste these lines together
x <- paste(c(x, ""), collapse = "\n")
hook_output(x, options)
}
)
```
# steward
[](https://www.tidyverse.org/lifecycle/#maturing)
[](https://github.com/uncoast-unconf/steward)
The goal of **steward** is to make it easier to import, manage, and publish the metadata associated with data frames. This might be useful for:
- [documenting a dataset](https://r-pkgs.org/data.html#documenting-data) for a package
- publishing a data-dictionary [table](https://gt.rstudio.com) in an R Markdown document
Our current definition of metadata includes the name, description and source of a dataset, as well as the name, type, and description of each of the variables in the dataset.
The name, steward, is an homage to the [Data Stewardship](http://agron590-isu.github.io/) class taught by [Andee Kaplan](https://github.com/andeek) and [Ranae Dietzel](https://github.com/ranae) (also an author of this package) at Iowa State University in Fall 2016.
This package was first built collaboratively at the [Uncoast Unconf](https://uuconf.rbind.io), held at Des Moines in April 2019.
## Installation
You can install the development version of steward from [GitHub](https://github.com/uncoast-unconf/steward) with:
```r
# install.packages("devtools")
devtools::install_github("uncoast-unconf/steward")
```
## Usage
In our [getting started article](https://uncoast-unconf.github.io/steward/articles/steward.html), we describe some common tasks:
- create a "steward" dataset.
- write a dataset to a package, with documentation.
- create a [gt table](https://gt.rstudio.com).
### Future development
We plan to release this package to CRAN as soon as the [gt](https://gt.rstudio.com) package is released there.
Some of the capabilities we plan to develop:
- take into account [timezone as column metadata](https://github.com/uncoast-unconf/steward/issues/39).
- for [readr](https://readr.tidyverse.org) and [vroom](https://vroom.r-lib.org), a way to build a [column specification to read a flat-file](https://github.com/uncoast-unconf/steward/issues/99).
- [build metadata from package-documentation](https://github.com/uncoast-unconf/steward/issues/43) (`.Rd` file)
## Related work
The [codebook](https://rubenarslan.github.io/codebook) package can help you manage dataset metadata.
## Code of conduct
Please note that the {steward} project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.