*! version 2.1 20240516

help file for repadolog

Title

repadolog - Outputs a report of what commands are installed in the PLUS folder

Syntax

repadolog [using] , [detail save savepath(string) quietly]

options

detail Display one line per command instead of one line per package

save Save the report in the current PLUS folder

savepath(string) Define a custom path for the report

quietly Do not display the report in the result window

Description

repadolog is a command that list what packages and commands are installed in the current PLUS folder together with meta data on these packages and commands. The meta data comes from the stata.trk which is what Stata use to keep track of which packages and which versions of these packages is installed in the current PLUS folder. This report can be used to get an inventory of installed commands.

Another, and perhaps more important, usage is as a reproducibility tool. This report can be shared to show exactly what commands and what version of them were installed on the computer that generated results intended to be reproducible.

This command can be used independently, but it also fits very well with the command repado. repado allows a team to set up a project specific PLUS folder shared in the team such that everyone in the team (and anyone reproducing the results in the future) use the exact same version of community contributed commands.

Options

using is used to use another stata.trk file than the one currently active. This is an advanced use case and this is expected to be rarely used. See the command repado for how to change which folder to use as the current PLUS folder and thereby change which is the current stata.trk file used.

detail generates a more detailed report. The default is to generate a report where each row represents a package where all commands in this package is listed in a column. When this option is used each row is a command. The same package meta data is included regardless if this option is used or not. However, command specific meta data is only included if this option is used.

save is used to save the report generated in a CSV file to disk. Unless savepath() is also used, the report is saved in the same location as the stata.trk file. If savepath() is used, then this option is redundant. The report is always overwritten if it already exists.

savepath(string) is used to specify the location and name of the CSV file where the report will be saved to disk. The report is always overwritten if it already exists.

quietly is used to suppress showing the report in Stata's result window.

Examples

Example 1.

This shows the most basic use case of repadolog. It searches for the stata.trk using the adopaths in the current Stata session. It outputs the report in the result window.

repadolog

Example 2.

In this example the option detail is used to provide meta info on all the commands installed in addition to meta info on the packages.

repadolog, detail

Example 3.

In this example, a CSV file named reapdolog.csv is saved with the report generated by this command in the code folder.

repadolog, detail savepath("${code}/repadolog.csv")

Feedback, bug reports and contributions

Read more about these commands on this repo where this package is developed. Please provide any feedback by opening an issue. PRs with suggestions for improvements are also greatly appreciated.

Authors

LSMS Team, The World Bank lsms@worldbank.org
DIME Analytics, The World Bank dimeanalytics@worldbank.org