{"id":14068721,"url":"https://github.com/tdhock/inlinedocs","last_synced_at":"2025-04-11T07:45:24.527Z","repository":{"id":17642337,"uuid":"20446785","full_name":"tdhock/inlinedocs","owner":"tdhock","description":"Convert inline comments and examples to Rd documentation files","archived":false,"fork":false,"pushed_at":"2023-10-17T21:45:14.000Z","size":201,"stargazers_count":2,"open_issues_count":1,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-25T05:18:44.315Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tdhock.png","metadata":{"files":{"readme":"README.org","changelog":"NEWS","contributing":null,"funding":null,"license":null,"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,"publiccode":null,"codemeta":null}},"created_at":"2014-06-03T14:50:10.000Z","updated_at":"2021-12-06T18:48:06.000Z","dependencies_parsed_at":"2022-09-22T14:25:35.972Z","dependency_job_id":"1ef06446-77f7-4e96-922e-6842ef43b8a1","html_url":"https://github.com/tdhock/inlinedocs","commit_stats":{"total_commits":53,"total_committers":3,"mean_commits":"17.666666666666668","dds":0.4339622641509434,"last_synced_commit":"28c0cd936c97becb619f50bbd2c8ad3f0f197a16"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tdhock%2Finlinedocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tdhock%2Finlinedocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tdhock%2Finlinedocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tdhock%2Finlinedocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tdhock","download_url":"https://codeload.github.com/tdhock/inlinedocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247934808,"owners_count":21020724,"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","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":[],"created_at":"2024-08-13T07:06:22.015Z","updated_at":"2025-04-11T07:45:24.476Z","avatar_url":"https://github.com/tdhock.png","language":"R","funding_links":[],"categories":["R"],"sub_categories":[],"readme":"[[http://inlinedocs.r-forge.r-project.org/][inlinedocs]]\n\n** Installation\n\nAs of 3 June 2014, inlinedocs from R-Forge is deprecated (please do\nnot use it). Please instead install from CRAN or this GitHub\nrepository,\n\n#+BEGIN_SRC R\n  install.packages(\"inlinedocs\")\n\n  if(!requireNamespace(\"remotes\"))install.packages(\"remotes\")\n  remotes::install_github(\"tdhock/inlinedocs\")\n#+END_SRC\n\n** Write documentation in comments\n\nSee [[http://inlinedocs.r-forge.r-project.org/][the R-Forge page]] for a summary of the kinds of comments that are\nrecognized as documentation by the default inlinedocs Parser Functions.\n\n** Convert comments to documentation\n\nRead comments in =pkg/R/*.R= files, then generate =pkg/man/*.Rd= files:\n\n#+BEGIN_SRC R\ninlinedocs::package.skeleton.dx(\"path/to/your/pkg\")\n#+END_SRC\n\n** Write your own Parser Function to extend inlinedocs\n\nDon't like the default syntax? Want to add a new feature? You can\nwrite your own Parser Functions that take your code/comments from *.R\nfiles as input, and return documentation as output. \nPlease read [[https://www.jstatsoft.org/article/view/v054i06][the JSS paper]] for an overview of how this works, and see\n[[file:inst/testfiles/alternate.R]] for an example.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftdhock%2Finlinedocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftdhock%2Finlinedocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftdhock%2Finlinedocs/lists"}