https://github.com/focardozom/DocumentData
A package created to document dataset
https://github.com/focardozom/DocumentData
datasets document documentation
Last synced: 4 months ago
JSON representation
A package created to document dataset
- Host: GitHub
- URL: https://github.com/focardozom/DocumentData
- Owner: focardozom
- License: other
- Created: 2022-11-10T00:02:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-10T21:34:07.000Z (about 1 year ago)
- Last Synced: 2024-08-13T07:11:33.130Z (8 months ago)
- Topics: datasets, document, documentation
- Language: R
- Homepage: https://focardozom.github.io/DocumentData/
- Size: 4.05 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - focardozom/DocumentData - A package created to document dataset (R)
README
[](https://github.com/focardozom/DocumentData/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/focardozom/DocumentData?branch=main)
# DocumentData 
`DocumentData` is an R package designed to facilitate dataset documentation during package creation. This package provides a *roxygen2-style* documentation skeleton with pre-filled information, saving time on typing and reducing the likelihood of errors. This feature promotes the generation of well-structured and standardized documentation, which is essential for efficient data management and usability.
# Install
Before installing `DocumentData`, you'll need to have `devtools` in your R setup. If you haven't installed `devtools` yet, you can do so with this command:
```
install.packages("devtools")
```
To install the `DocumentData` package, run the following code in your R environment:
```
devtools::install_github("focardozom/DocumentData")
```
# Usage Example
Here's a quick example to show you how to use the document_data function. It creates a file right in your working directory. It creates a detailed documentation skeleton for your dataset, formatted in roxygen2 style.
```
the_data <- as.data.frame(datasets::Titanic)
DocumentData::document_data(the_data)
```
Thank you for considering `DocumentData` for your data documentation needs. I hope this tool makes your data management process smoother and more efficient. Should you have any questions, feedback, or suggestions, please feel free to reach out or contribute to the project.
Happy documenting! :star::star::star: