Stata:如何撰写具有自动更新功能的Stata命令-updatecmd

发布时间:2021-11-24 阅读 112

Stata连享会   主页 || 视频 || 推文 || 知乎 || Bilibili 站

温馨提示: 定期 清理浏览器缓存,可以获得最佳浏览体验。

New! lianxh 命令发布了:
随时搜索推文、Stata 资源。安装:
. ssc install lianxh
详情参见帮助文件 (有惊喜):
. help lianxh
连享会新命令:cnssc, ihelp, rdbalance, gitee, installpkg

课程详情 https://gitee.com/lianxh/Course

课程主页 https://gitee.com/lianxh/Course

⛳ Stata 系列推文:

PDF下载 - 推文合集

作者:杜克锐


目录


1. 设计思路

前段时间发现 Gitee.com 的网页源代码更改了,导致原来写的用于安装的 gitee 命令 (用于安装 gitee 上的程序包) 无法使用。因此,不得不修改一下 gitee 命令,然后再发给 Baum 更新到 ssc 上。

但考虑到 Gitee.com 可能以后还会更改网页源代码,gitee 命令也得做相应更新。索性就在 gitee 命令中加入一段代码,用于检测是否有新版本的程序,并自动更新。代码原理很简单,就是对比一下电脑本地的 gitee.ado 的版本号与服务器上的版本号,如果本地命令版本号低于线上版本就重新安装 gitee 进行更新。

完成这项工作后,觉得有必要把自动更新程序提取出来写一个独立的命令,嵌入我的其他命令,以方便用户进行相关命令的更新,并及时修正命令存在的 bugs。

于是我开始更进一步的思考。gitee 命令做的是简单的爬虫工作,本身就是需要跟网络进行连接,并获取正确的内容。如果 Gitee.com 更改网页源代码,gitee 命令也得做对应的修改,要不用户无法使用。所以对于 gitee 命令强制更新似乎是可以接受的。

但对于其他命令,强制更新会更改用户电脑上的文件,显然不太合适,这应该由用户自己决定。所以在检查到新命令的时候,应该告知用户有新版本的命令,让用户选择是否更新。这就涉及到一个 Stata 与用户进行交互的问题。利用 Stata 的 Dialog programming,我设计了一个简单的弹窗。一旦检测到有新版本的命令,Stata 会弹出如下窗口,用户需要在 Yes 前面打钩 ✔,点 Next 进入更新;否则跳过更新。

更进一步地,我希望加入更新代码后对用户的干扰越小越好。如果没有检测到新版本,命令执行原来的功能,用户不会感知到检测更新的存在。如果存在新版本,用户可以选择更新或者不更新,然后程序继续执行原来的功能。要实现这目标,那么程序就需要进行递归。我用如下简单的流程图来说明:

另外一个问题是 Stata 用户可能在工作中会多次地使用一个命令,让命令每次调用都进行检测更新没有必要,也浪费时间和资源。对此,我可以用一个 global 来记录更新检测的状态,如果是已经检测过更新,那么后续用户再使用命令的时候就会跳过检测更新,执行原有的命令。最后,我将这一更新方法写成了新的命令 updatecmdupdatecmd2,可以作为 routine 用于嵌入用户的开发命令中,实现自动更新。

2. 具体示例

接下来,我将以下面例子进行说明。demo_updatecmd 命令是个 demo,其功能只是在 Stata 控制台显示 "hello, your code written here"。

*! version 0.02 
cap program drop demo_updatecmd
program define demo_updatecmd
    version 16   
    di "hello, your code written here" 
end

为了使得这个命令可以自动更新,需要在 di "hello, your code written here" 上面加入以下代码。其中,

  • 第 7-8 行,local pkglocal cmdname 分别放入命令所属的程序包名称和命令本身名称;
  • 第 9-10 行提供程序的安装源。global c_m_d_0 存入命令行所输入的内容;
  • 第 11-18 行在线安装 updatecmd 程序包;
  • 第 24 行用 ${up_grade_`pkg'} 判断是否已经检测过更新,如果没有检测过,则进入检测更新环节;
  • 第 26 行是核心,调用 updatecmd 进行检测更新,from()froma() 提供了两个线上程序下载源。如果从 from() 检测程序失败,则进一步使用 froma( ) 的程序源。这里主要考虑到国内用户可能上不了 github,而国外用户可能用不了 gitee;
  • 第 29 行之后则可以写原有命令的内容。Stata 命令开发者只需第 6-29 行放入自己的命令中,并更替第 7-10 行的参数后,并可实现使用这个自动更新 routine。
*! version 0.02 
cap program drop demo_updatecmd
program define demo_updatecmd
    version 16   
    **********************************************
    *** 需要更改的内容
    local pkg       updatecmd // updatecmd should be replaced with your package name
    local cmdname   updatecmd //当前的命令名称
    local from      "https://gitee.com/kerrydu/kgitee/raw/master/"
    local froma     "https://github.com/kerrydu/kgitee/raw/master/" //可缺省
    *******Check whether a new version is available
    global c_m_d_0  `0'  
    //install the updatecmd package if it is missing    
    cap which updatecmd
    if _rc{
        cap net install updatecmd, from("https://github.com/kerrydu/kgitee/raw/master/") replace
        if _rc{
        cap net install updatecmd, from("https://gitee.com/kerrydu/kgitee/raw/master/") replace
        if _rc global up_grade_`pkg' "updatecmd_is_missing"
        }
    }
    //the first run of the command defines global up_grade_`pkg'
    local checkcmd 0
    if "${up_grade_`pkg'}"==""{ 
        local checkcmd 1
        updatecmd `cmdname',  from(`from') froma(`froma') pkg(`pkg') 	
    } 
    if `checkcmd' exit
    ********************************************
    di "hello, your code written here" // the content of your command placed here
end

需要特别说明的是,命令更新的判断依据是 ado 文件中的命令版本号。为了正确提取版本号,我在 updatecmd 中做了一些约定,只有 version #.#### 这样的版本号才能被 updatecmd 识别出来。因此,使用 updatecmd 进行自动更新,建议在 ado 文件的首行,写入这样的版本信息 !* version #, date

其中,# 必须为一个实数,不能出现字母,也不能是 #.#.#.# 的形式。在与连老师进行交流后,我又增加了 updatecmd2 命令,可以用于版本号为 #.#.#.# 的形式。提取到错误版本号可能造成一些未知的错误,为了谨慎起见,我仍排除了版本号中有字母的形式。例如 1.223a 是不能被 updatecmdupdatecmd2 所识别。

最后,局限个人的能力和时间,我这里只是探索性地提供一个思路来实现 Stata 命令的自动更新,还存在大量的问题没有解决。例如,弹窗还比较简陋,缺少版本号信息和版本更新的功能说明。感兴趣的朋友可以自行探索。相关程序代码在 kgitee: install Stata package issued by Kerry Du in Gitee.com。这是个简单的想法,欢迎大家提供改进意见。

3. 相关推文

Note:产生如下推文列表的 Stata 命令为:
lianxh 编程 程序, m
安装最新版 lianxh 命令:
ssc install lianxh, replace

相关课程

免费公开课

最新课程-直播课

专题 嘉宾 直播/回看视频
最新专题 文本分析、机器学习、效率专题、生存分析等
研究设计 连玉君 我的特斯拉-实证研究设计-幻灯片-
面板模型 连玉君 动态面板模型-幻灯片-
面板模型 连玉君 直击面板数据模型 [免费公开课,2小时]
  • Note: 部分课程的资料,PPT 等可以前往 连享会-直播课 主页查看,下载。

课程主页

课程主页

关于我们

  • Stata连享会 由中山大学连玉君老师团队创办,定期分享实证分析经验。
  • 连享会-主页知乎专栏,700+ 推文,实证分析不再抓狂。直播间 有很多视频课程,可以随时观看。
  • 公众号关键词搜索/回复 功能已经上线。大家可以在公众号左下角点击键盘图标,输入简要关键词,以便快速呈现历史推文,获取工具软件和数据下载。常见关键词:课程, 直播, 视频, 客服, 模型设定, 研究设计, stata, plus, 绘图, 编程, 面板, 论文重现, 可视化, RDD, DID, PSM, 合成控制法

连享会小程序:扫一扫,看推文,看视频……

扫码加入连享会微信群,提问交流更方便

✏ 连享会-常见问题解答:
https://gitee.com/lianxh/Course/wikis

New! lianxhsongbl 命令发布了:
随时搜索连享会推文、Stata 资源,安装命令如下:
. ssc install lianxh
使用详情参见帮助文件 (有惊喜):
. help lianxh