An R package that automates R package documentation and namespace management by generating populated roxygen2 skeletons.
Sinew is an R package that automates the generation of roxygen2 documentation skeletons and manages namespaces for R package development. It scrapes information from function scripts to populate documentation, reducing the manual effort required for maintaining package documentation and dependencies. The tool is designed to make package creation and maintenance more accessible by automating repetitive tasks.
R developers and researchers who create or maintain R packages, particularly those looking to streamline documentation workflows and ensure consistency across functions.
Developers choose Sinew because it significantly reduces the time and effort needed for documentation and namespace management, offers both command-line and interactive Shiny gadget interfaces, and helps maintain high-quality, consistent documentation automatically.
Generate roxygen2 skeletons populated with information scraped from the function script.
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Generates populated roxygen2 skeletons by scraping function scripts, reducing manual entry for parameters and defaults as described in the README.
Programmatically attaches namespaces to functions and updates the DESCRIPTION file's Imports field, streamlining package setup and maintenance.
Provides a Shiny gadget addin for interactive use within RStudio, allowing real-time documentation updates on installed or new functions.
Automates updates to parameters and definitions across functions, ensuring documentation stays current with code changes, as emphasized in the philosophy.
Heavily relies on RStudio for the interactive gadget and roxygen2 for documentation, making it less effective in other IDEs or for projects using alternative documentation systems.
Automated changes might not align with custom documentation styles or advanced roxygen2 features, requiring manual intervention and review.
Focused solely on R package development, so it offers no support for other languages or documentation frameworks, limiting its utility in mixed environments.