ADODOWN: Stata module making Stata packages easier to develop and document using modern tools

Team Lsms ()
Additional contact information
Team Lsms: The World Bank

Statistical Software Components from Boston College Department of Economics

Abstract: For developers, adodown offers workflow commands that automate manual tasks at each stage of development. At project's start, adodown creates the necessary scaffolding for the package (e.g., folders, `pkg` file, etc). For each package command, it uses templates to create necessary files (i.e., ado, documentation, unit test) and adds appropriate entries in the pkg file. For documentation, it allows developers draft in plain Markdown while creating standard help files in SMCL. And for publication, adodown collects the required files, puts them in proper format, and prepares a zip file for SSC submission. Also, adodown automatically deploys a package documentation website. For users, this provides an easy way to discover packages, to understand what they do, and to explore how commands work--all without installing the package. For developers, this provides packages with a welcome web presence and offers a home for additional documentation (e.g., how-to guides, technical notes, FAQs), and keeps HTML documentation up to date with SMCL documentation through continuous deployment via GitHub Actions.

Language: Stata
Requires: Stata version 14.1
Keywords: package management; templates; SSC (search for similar items in EconPapers)
Date: 2024-02-25, Revised 2024-07-31
Note: This module should be installed from within Stata by typing "ssc install adodown". The module is made available under terms of the GPL v3 (https://www.gnu.org/licenses/gpl-3.0.txt). Windows users should not attempt to download these files with a web browser.
References: Add references at CitEc
Citations:

Downloads: (external link)
http://fmwww.bc.edu/repec/bocode/a/ad_update.ado program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad_pkg_meta.ado program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/adodown.ado program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad_publish.ado program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad_setup.ado program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/adFile-URL:http ... bocode/_/command.ado program code (text/plain)
Our link check indicates that this URL is bad, the error code is: 404 Not Found
http://fmwww.bc.edu/repec/bocode/a/ad_sthlp.ado program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad_update.sthlp help file (text/plain)
http://fmwww.bc.edu/repec/bocode/a/adodown.sthlp help file (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad_publish.sthlp help file (text/plain)
http://fmwww.bc.edu/repec/bocode/a/adFile-URL:http ... code/_/command.sthlp help file (text/plain)
Our link check indicates that this URL is bad, the error code is: 404 Not Found
http://fmwww.bc.edu/repec/bocode/a/ad_setup.sthlp help file (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad_sthlp.sthlp help file (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad-cmd-command.ado program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad-cmd-command.do program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad-cmd-command.md program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad-gh-workflows.yaml program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad-gh.gitignore program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad-reproot.yaml program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad-src-ado-README.md program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad-src-dev-description.txt program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad-src-dev-README.md program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad-src-mdhlp-README.md program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad-src-package.pkg program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad-src-stata.toc program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad-src-sthlp-README.md program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad-src-tests-README.md program code (text/plain)
http://fmwww.bc.edu/repec/bocode/a/ad-src-vignettes-README.md program code (text/plain)

Related works:
This item may be available elsewhere in EconPapers: Search for items with the same title.

Export reference: BibTeX RIS (EndNote, ProCite, RefMan) HTML/Text

Persistent link: https://EconPapers.repec.org/RePEc:boc:bocode:s459309

Ordering information: This software item can be ordered from
http://repec.org/docs/ssc.php

Access Statistics for this software item

More software in Statistical Software Components from Boston College Department of Economics Boston College, 140 Commonwealth Avenue, Chestnut Hill MA 02467 USA. Contact information at EDIRC.
Bibliographic data for series maintained by Christopher F Baum ().