IDEAS home Printed from https://ideas.repec.org/c/boc/bocode/s459309.html
 

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

Author

Listed:
  • LSMS Team

    (The World Bank)

Programming Language

Stata

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.

Suggested Citation

  • LSMS Team, 2024. "ADODOWN: Stata module making Stata packages easier to develop and document using modern tools," Statistical Software Components S459309, Boston College Department of Economics.
    • Handle: RePEc:boc:bocode:s459309
    Note: This module should be installed from within Stata by typing "ssc install repkit". 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.
    as

    Download full text from publisher

    File URL: http://fmwww.bc.edu/repec/bocode/a/ad_update.ado
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad_pkg_meta.ado
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/adodown.ado
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad_publish.ado
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad_setup.ado
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad_command.ado
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad_sthlp.ado
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad_update.sthlp
    File Function: help file
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/adodown.sthlp
    File Function: help file
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad_publish.sthlp
    File Function: help file
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad_command.sthlp
    File Function: help file
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad_setup.sthlp
    File Function: help file
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad_sthlp.sthlp
    File Function: help file
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad-cmd-command.ado
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad-cmd-command.do
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad-cmd-command.md
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad-gh-workflows.yaml
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad-gh.gitignore
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad-reproot.yaml
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad-src-ado-README.md
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad-src-dev-description.txt
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad-src-dev-README.md
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad-src-mdhlp-README.md
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad-src-package.pkg
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad-src-stata.toc
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad-src-sthlp-README.md
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad-src-tests-README.md
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/a/ad-src-vignettes-README.md
    File Function: program code
    Download Restriction: no
    ---><---

    Corrections

    All material on this site has been provided by the respective publishers and authors. You can help correct errors and omissions. When requesting a correction, please mention this item's handle: RePEc:boc:bocode:s459309. See general information about how to correct material in RePEc.

    If you have authored this item and are not yet registered with RePEc, we encourage you to do it here. This allows to link your profile to this item. It also allows you to accept potential citations to this item that we are uncertain about.

    We have no bibliographic references for this item. You can help adding them by using this form .

    If you know of missing items citing this one, you can help us creating those links by adding the relevant references in the same way as above, for each refering item. If you are a registered author of this item, you may also want to check the "citations" tab in your RePEc Author Service profile, as there may be some citations waiting for confirmation.

    For technical questions regarding this item, or to correct its authors, title, abstract, bibliographic or download information, contact: Christopher F Baum (email available below). General contact details of provider: https://edirc.repec.org/data/debocus.html .

    Please note that corrections may take a couple of weeks to filter through the various RePEc services.

    IDEAS is a RePEc service. RePEc uses bibliographic data supplied by the respective publishers.