Data

Tools

Indexes

Applications

Experiments

Open Source Science

sinew

Generate roxygen2 skeletons populated with information scraped from the function script.

https://github.com/yonicd/sinew

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.3%) to scientific vocabulary

Keywords from Contributors

shiny-apps shiny ggplot-extension
Last synced: 11 months ago · JSON representation

Repository

Generate roxygen2 skeletons populated with information scraped from the function script.

Basic Info
Statistics
  • Stars: 165
  • Watchers: 10
  • Forks: 15
  • Open Issues: 5
  • Releases: 0
Created over 9 years ago · Last pushed over 2 years ago
Metadata Files
Readme Changelog License

README.md

CRAN\_Status\_Badge R-check build status Coverage Status Covrpage Summary

Sinew

Sinew is a R package that facilitates R package documentation and namespaces managment for developers of all levels.

tldr

What can it do?

  • Programatically attach namespaces to functions in R and Rmd script
  • Generate Roxygen2 skeletons populated with information scraped from within functions
  • Populate the Imports field of the DESCRIPTION file.

Installation

CRAN

r install.packages('sinew')

DEV

r install.packages('remotes') remotes::install_github('yonicd/sinew')

More Details

At the core of creating reproducible research is the daunting process of documentation, and working with R presents no exception. The standardized R package documentation is part of the appeal for new (and experienced) users, where concise, clear instructions are cherished. Packages are great for reusing scripts in a consistent fashion and for developers, package creation helps organizing and maintaining their ideas.

The barrier to entry for package maintenance and documentation, however may be too high for R users embarking on the task of package creation, thereby discouraging them from development. The out-of-the-box roxygen2 skeleton supplied by RStudio gives the bare bones road map of what should be part of function documentation.

The goal of sinew is to automate nearly all of the manual tasks needed to document functions, properly set up the import fields for oxygenation, and make it easier to attain documentation consistency across functions and packages.

Once the initial documentation is set, sinew can be used as part of the natural maintenance workflow to automatically change and append updated parameters, definitions, defaults, add namespacing to functions and dependencies, making your documentation great - again!

sinew is built for both command line and interactive users through a Shiny gadget that can be called from the addin menu. The addin can be used on any function either installed, in the search path, one you just wrote, or one your need to update.

Owner

  • Login: yonicd
  • Kind: user
  • Location: Cambridge, MA
  • Company: Sage Therapeutics

Data welder 👨‍🏭 and Research Scientist

GitHub Events

Total
Last Year

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 215
  • Total Committers: 25
  • Avg Commits per committer: 8.6
  • Development Distribution Score (DDS): 0.46
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Jonathan Sidi y****d@g****m 116
Jonathan Sidi y****s@m****m 57
Stephen Synchronicity 3****h 11
Anton Grishin g****3@o****m 8
GitHub Actions a****s@g****m 3
Devin Pastoor d****r@a****m 1
runner r****r@M****l 1
runner r****r@M****l 1
runner r****r@M****l 1
runner r****r@M****l 1
runner r****r@M****l 1
runner r****r@M****l 1
runner r****r@M****l 1
runner r****r@M****l 1
runner r****r@M****l 1
runner r****r@M****l 1
runner r****r@M****l 1
runner r****r@M****l 1
runner r****r@M****l 1
runner r****r@M****l 1
Alexey Shiklomanov a****v@g****m 1
Eli Pousson e****n@g****m 1
Enrico Spinielli e****i@g****m 1
Tal Galili t****i@g****m 1
amrrs a****s@o****m 1
Committer Domains (Top 20 + Academic)
amgen.com: 1 github.com: 1 metrumrg.com: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 37
  • Total pull requests: 42
  • Average time to close issues: 3 months
  • Average time to close pull requests: about 2 months
  • Total issue authors: 22
  • Total pull request authors: 13
  • Average comments per issue: 4.46
  • Average comments per pull request: 2.21
  • Merged pull requests: 35
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • yogat3ch (5)
  • talgalili (4)
  • januz (3)
  • daniel258 (2)
  • GitHunter0 (2)
  • yonicd (2)
  • grishin1 (2)
  • dpastoor (2)
  • lbusett (2)
  • LiRogers (1)
  • jestarr (1)
  • ashenkin (1)
  • elipousson (1)
  • jonocarroll (1)
  • Blackglade (1)
Pull Request Authors
  • yonicd (16)
  • yogat3ch (14)
  • grishin1 (3)
  • lbusett (1)
  • amrrs (1)
  • espinielli (1)
  • Blackglade (1)
  • elipousson (1)
  • andrewdolman (1)
  • earnaud (1)
  • talgalili (1)
  • dpprdan (1)
  • ashiklom (1)
Top Labels
Issue Labels
bug (1) enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 822 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 5
  • Total versions: 7
  • Total maintainers: 1
cran.r-project.org: sinew

Package Development Documentation and Namespace Management

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 5
  • Downloads: 822 Last month
Rankings
Stargazers count: 2.5%
Forks count: 4.4%
Dependent repos count: 13.0%
Average: 13.2%
Downloads: 17.6%
Dependent packages count: 28.7%
Maintainers (1)
yonicd@gmail.com
Last synced: 11 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.2.0 depends
  • cli * imports
  • crayon * imports
  • rematch2 * imports
  • rstudioapi * imports
  • sos * imports
  • stringi * imports
  • tools * imports
  • utils * imports
  • yaml * imports
  • details * suggests
  • fs * suggests
  • git2r * suggests
  • knitr * suggests
  • miniUI * suggests
  • rcmdcheck * suggests
  • rmarkdown * suggests
  • roxygen2 * suggests
  • shiny * suggests
  • testthat * suggests
  • usethis * suggests
  • withr * suggests
inst/pkg/DESCRIPTION cran
.github/workflows/R-check.yml actions
  • JamesIves/github-pages-deploy-action 4.1.4 composite
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite