JMSLab / xtevent

Stata package -xtevent-
MIT License
43 stars 12 forks source link

prepare release xtevent 3.0.0 #165

Closed Constantino-Carreto-Romero closed 6 months ago

Constantino-Carreto-Romero commented 11 months ago

In this issue, we'll update documentation for the release of xtevent 3.0.0

Constantino-Carreto-Romero commented 10 months ago

According to Semver, #166 would imply backward incompatible changes. Therefore, version would increase to 3.0.0 instead of 2.3.0.

Constantino-Carreto-Romero commented 10 months ago

This issue branch was 3 commits behind the main branch. I brought up to date this issue branch with the main branch after bringing commits https://github.com/JMSLab/xtevent/commit/4198174fab4a012e3ab69eca0b76f2ecc9199e40, https://github.com/JMSLab/xtevent/commit/8cabed50efd6d02132e3c66d56203b6ff2099591, https://github.com/JMSLab/xtevent/commit/dbe046a862859262b098f82e24ab787932f78a55. The branch is now up to date with main.

Constantino-Carreto-Romero commented 10 months ago

in https://github.com/JMSLab/xtevent/commit/a91c3883999eadcfbe5edcba03492b594a0b19b5 I uploaded a copy of the current main branch version of xtevent, downloaded as a zip file.

jmshapir commented 10 months ago

In 36e0f9a I updated the readme to include a citation to the Stata Journal submission (and to update the other citation).

Constantino-Carreto-Romero commented 7 months ago

@jorpppp in https://github.com/JMSLab/xtevent/commit/dc9b4f95432bea6502d636d52d3f4740234d7810 I updated examples in the test file using the option for the label for the mean of the dependent variable since it changed in commit https://github.com/JMSLab/xtevent/commit/97cbccd4c3c1bb305753197eb891f55b1900a1da

Constantino-Carreto-Romero commented 7 months ago

I got an error message when running the test file's examples with the option addabsorb. For instance, when running:

xtevent y eta, policyvar(z) window(3) proxy(x) nofe note addabsorb(k) reghdfe

I got the error message:

last estimates not found
r(301);

I had the latest ssc version of reghdfe installed. After revisiting a little, I found the problem came from reghdfe (and not from xtevent). This statalist post mentions this problem. Once I installed the latest github version of reghdfe (along with its dependencies), the code ran properly. Maybe I could add some message to the home page, in the installation section, recommending the user to install the latest github version of reghdfe. Currently, when the user installs xtevent, the program automatically tries to install the latest ssc version of reghdfe.

I didn't have any additional problems when running the rest of the examples in the test file.

Constantino-Carreto-Romero commented 7 months ago

@jorpppp in https://github.com/JMSLab/xtevent/commit/7cb771d5dc4cae4516862f6c5d6f3fe1cbc85e76 and https://github.com/JMSLab/xtevent/commit/bbc53098a9b50e3a466592e1f5f7e17909e327d4 I updated the home page to include the description for the 3.0.0 version. I just created a draft for the release here.

Constantino-Carreto-Romero commented 7 months ago

@jorpppp In:

Constantino-Carreto-Romero commented 7 months ago

Thread continues in its pull request #168