{"id":14066657,"url":"https://github.com/focardozom/DocumentData","last_synced_at":"2025-07-29T23:31:59.093Z","repository":{"id":113805607,"uuid":"564076665","full_name":"focardozom/DocumentData","owner":"focardozom","description":"A package created to document dataset","archived":false,"fork":false,"pushed_at":"2024-02-10T21:34:07.000Z","size":4248,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-04T06:36:42.172Z","etag":null,"topics":["datasets","document","documentation"],"latest_commit_sha":null,"homepage":"https://focardozom.github.io/DocumentData/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/focardozom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-11-10T00:02:14.000Z","updated_at":"2024-08-12T23:41:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"2a955cd9-df44-4986-a4ed-0c634fec48be","html_url":"https://github.com/focardozom/DocumentData","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/focardozom/DocumentData","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/focardozom%2FDocumentData","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/focardozom%2FDocumentData/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/focardozom%2FDocumentData/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/focardozom%2FDocumentData/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/focardozom","download_url":"https://codeload.github.com/focardozom/DocumentData/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/focardozom%2FDocumentData/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267780010,"owners_count":24143201,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["datasets","document","documentation"],"created_at":"2024-08-13T07:05:12.334Z","updated_at":"2025-07-29T23:31:58.649Z","avatar_url":"https://github.com/focardozom.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"\u003c!-- badges: start --\u003e\n[![R-CMD-check](https://github.com/focardozom/DocumentData/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/focardozom/DocumentData/actions/workflows/R-CMD-check.yaml)\n[![Codecov test coverage](https://codecov.io/gh/focardozom/DocumentData/branch/main/graph/badge.svg)](https://app.codecov.io/gh/focardozom/DocumentData?branch=main)\n\u003c!-- badges: end --\u003e\n\n# DocumentData \u003ca href=\"https://focardozom.github.io/DocumentData/\"\u003e\u003cimg src=\"man/figures/logo.png\" align=\"right\" height=\"138\" alt=\"DocumentData website\" /\u003e\u003c/a\u003e\n\n`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.\n\n# Install\n\nBefore 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:\n\n```\ninstall.packages(\"devtools\")\n```\n\nTo install the `DocumentData` package, run the following code in your R environment:\n\n```\ndevtools::install_github(\"focardozom/DocumentData\")\n```\n\n# Usage Example\n\nHere'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.\n\n```\nthe_data \u003c- as.data.frame(datasets::Titanic)\nDocumentData::document_data(the_data)\n```\n\nThank 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. \n\nHappy documenting! :star::star::star:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffocardozom%2FDocumentData","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffocardozom%2FDocumentData","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffocardozom%2FDocumentData/lists"}