diff --git a/README.md b/README.md index e72bff1..bc386ae 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,9 @@ Currently, this toolkit has the following commands: | Command | Description | | --- | --- | -| [repado](https://dime-worldbank.github.io/repkit/reference/repado.html) | Command used to manage project ado command dependencies. This command provides a way to make sure that all team members as well as future reproducers of the projects code use the exact same version of all command dependencies. | -| [repkit](https://dime-worldbank.github.io/repkit/reference/repkit.html) | Command named the same as the package. Most important purpose is that this command makes the code `which repkit` work. | -| [reprun](https://dime-worldbank.github.io/repkit/reference/reprun.html) | This command is used to automate reproducibility checks by running a do-file or a set of do-files and compare all state values (RNG-value, datasignature etc.) between the two runs. This command is currently only release as a beta-version. | +| [repado](https://worldbank.github.io/repkit/reference/repado.html) | Command used to manage project ado command dependencies. This command provides a way to make sure that all team members as well as future reproducers of the projects code use the exact same version of all command dependencies. | +| [repkit](https://worldbank.github.io/repkit/reference/repkit.html) | Command named the same as the package. Most important purpose is that this command makes the code `which repkit` work. | +| [reprun](https://worldbank.github.io/repkit/reference/reprun.html) | This command is used to automate reproducibility checks by running a do-file or a set of do-files and compare all state values (RNG-value, datasignature etc.) between the two runs. This command is currently only release as a beta-version. | # Installation @@ -35,29 +35,29 @@ ssc install repkit You can install older versions of `repkit` directly from the GitHub repository. To do so, start by finding the tag corresponding to the version you want to install here: -https://github.com/dime-worldbank/repkit/tags. +https://github.com/worldbank/repkit/tags. Update the local "tag" in the code below with the value of the tag you picked, and then run the code. ``` local tag "v1.0" net install repkit, /// - from("https://raw.githubusercontent.com/dime-worldbank/repkit/`tag'/src") + from("https://raw.githubusercontent.com/worldbank/repkit/`tag'/src") ``` # Contributions This package is developed in -[this repo](https://github.com/dime-worldbank/repkit) +[this repo](https://github.com/worldbank/repkit) on GitHub using the [adodown](https://github.com/lsms-worldbank/adodown) workflow. We are happy to receive feedback and/or contributions. Please feel free to report bugs or request new features by opening up a -[new issue](https://github.com/dime-worldbank/repkit/issues). +[new issue](https://github.com/worldbank/repkit/issues). You are also welcome to fork this repo and submit a -[pull request](https://github.com/dime-worldbank/repkit/pulls) +[pull request](https://github.com/worldbank/repkit/pulls) with contribution to the code. # Authors diff --git a/src/ado/repkit.ado b/src/ado/repkit.ado index 9ba29c1..f594a46 100644 --- a/src/ado/repkit.ado +++ b/src/ado/repkit.ado @@ -38,7 +38,7 @@ cap program drop repkit noi di _n "{hline}" _n noi di as text "{pstd}{ul:{red:Warning:} This command {inp:`subtwo'} is currently only released as a beta release}{p_end}" _n - noi di as text `"{pstd}We're excited to introduce a beta release of the command {inp:`subtwo'}. Feedback from users like you will help us refine and finalize this command. We, especially during the beta phase, welcome bug reports, feature requests, and any other comments at: {browse "https://github.com/dime-worldbank/repkit/issues"}.{p_end}"' _n + noi di as text `"{pstd}We're excited to introduce a beta release of the command {inp:`subtwo'}. Feedback from users like you will help us refine and finalize this command. We, especially during the beta phase, welcome bug reports, feature requests, and any other comments at: {browse "https://github.com/worldbank/repkit/issues"}.{p_end}"' _n noi di as text "{pstd}Please note that during the beta release we might rename or remove options without building in backward compatibility, and some still experimental features might not be fully documented.{p_end}" _n noi di _n "{hline}" } diff --git a/src/mdhlp/repado.md b/src/mdhlp/repado.md index 860f510..a8d135d 100644 --- a/src/mdhlp/repado.md +++ b/src/mdhlp/repado.md @@ -69,7 +69,7 @@ repado using "${myproj}/ado", nostrict # Feedback, bug reports and contributions -Read more about these commands on [this repo](https://github.com/dime-worldbank/repkit) where this package is developed. Please provide any feedback by [opening an issue](https://github.com/dime-worldbank/repkit/issues). PRs with suggestions for improvements are also greatly appreciated. +Read more about these commands on [this repo](https://github.com/worldbank/repkit) where this package is developed. Please provide any feedback by [opening an issue](https://github.com/worldbank/repkit/issues). PRs with suggestions for improvements are also greatly appreciated. # Authors diff --git a/src/mdhlp/repkit.md b/src/mdhlp/repkit.md index a905c47..9aeade3 100644 --- a/src/mdhlp/repkit.md +++ b/src/mdhlp/repkit.md @@ -20,7 +20,7 @@ This command has no options. # Feedback, bug reports and contributions -Read more about these commands on [this repo](https://github.com/dime-worldbank/repkit) where this package is developed. Please provide any feedback by [opening an issue](https://github.com/dime-worldbank/repkit/issues). PRs with suggestions for improvements are also greatly appreciated. +Read more about these commands on [this repo](https://github.com/worldbank/repkit) where this package is developed. Please provide any feedback by [opening an issue](https://github.com/worldbank/repkit/issues). PRs with suggestions for improvements are also greatly appreciated. # Authors diff --git a/src/mdhlp/reprun.md b/src/mdhlp/reprun.md index 4910a09..918a1fe 100644 --- a/src/mdhlp/reprun.md +++ b/src/mdhlp/reprun.md @@ -46,7 +46,7 @@ By default, __reprun__ invokes __clear__ and __set seed 12345__ to match the def # Feedback, bug reports and contributions -Read more about these commands on [this repo](https://github.com/dime-worldbank/repkit) where this package is developed. Please provide any feedback by [opening an issue](https://github.com/dime-worldbank/repkit/issues). PRs with suggestions for improvements are also greatly appreciated. +Read more about these commands on [this repo](https://github.com/worldbank/repkit) where this package is developed. Please provide any feedback by [opening an issue](https://github.com/worldbank/repkit/issues). PRs with suggestions for improvements are also greatly appreciated. # Authors diff --git a/src/repkit.pkg b/src/repkit.pkg index 2c8c00a..20b351d 100644 --- a/src/repkit.pkg +++ b/src/repkit.pkg @@ -1,8 +1,8 @@ * This package file is generated in the adodown workflow. Do not edit directly. *** version v 1.1 -*** name -d repkit +*** Title +d 'REPKIT': A module with tools related to collaboration and computational reproducibility *** description d A Stata package with tools related to computational reproducibility d @@ -10,9 +10,9 @@ d d Version: Stata 14.1 d *** author -d Author: DIME Analytics +d Author: DIME Analytics, LSMS Team *** contact -d Contact: dimeanalytics@worldbank.org +d Contact: dimeanalytics@@worldbank.org, lsms@@worldbank.org *** url d URL: https://github.com/worldbank/repkit d diff --git a/src/tests/reprun/with-ado-folder/main.do b/src/tests/reprun/with-ado-folder/main.do index a21d31e..8ee522a 100644 --- a/src/tests/reprun/with-ado-folder/main.do +++ b/src/tests/reprun/with-ado-folder/main.do @@ -1,7 +1,7 @@ ********************************************************************** -* Read about this code segment here: https://dime-worldbank.github.io/repkit/articles/ado-management-with-repado.html#alternative +* Read about this code segment here: https://worldbank.github.io/repkit/articles/ado-management-with-repado.html#alternative sysdir set PLUS "${waf}/ado" adopath ++ PLUS diff --git a/src/vignettes/ado-management-with-repado.md b/src/vignettes/ado-management-with-repado.md index ec0d849..10da9a1 100644 --- a/src/vignettes/ado-management-with-repado.md +++ b/src/vignettes/ado-management-with-repado.md @@ -1,6 +1,6 @@ # Using `repado` for Ado-File Management -_This is a comprehensive guide on how to use `repado`. For a shorter and more technical syntax documentation, refer to the [helpfile](https://dime-worldbank.github.io/repkit/reference/repado.html)._ +_This is a comprehensive guide on how to use `repado`. For a shorter and more technical syntax documentation, refer to the [helpfile](https://worldbank.github.io/repkit/reference/repado.html)._ ## Background @@ -330,7 +330,7 @@ Both examples assume the same folder structure as previously outlined. Before using any of these examples, ensure they are utilizing the most recent version of the code used in the `repado` command -[here](https://github.com/dime-worldbank/repkit/blob/main/src/ado/repado.ado). +[here](https://github.com/worldbank/repkit/blob/main/src/ado/repado.ado). **Example 1:** In this example, the same results are achieved as when using `repado` in strict mode. diff --git a/src/vignettes/reproot-files.md b/src/vignettes/reproot-files.md index db1478e..97dc071 100644 --- a/src/vignettes/reproot-files.md +++ b/src/vignettes/reproot-files.md @@ -45,7 +45,7 @@ root_name : "code" If these files are shared over DropBox/OneDrive/Git/Network, etc. among the other files shared in that method, then the root file only needs to be set up once per location by a single member of the project. Then all other project members can use the same files. -A template root file can be downloaded from [here](https://github.com/dime-worldbank/repkit/blob/main/src/dev/reproot.yaml) for you to download it and modify it to your needs. +A template root file can be downloaded from [here](https://github.com/worldbank/repkit/blob/main/src/dev/reproot.yaml) for you to download it and modify it to your needs. ### `reproot-env.yaml` - the settings file @@ -105,4 +105,4 @@ skipdirs: - ".git" ``` -This file can be downloaded from [here](https://github.com/dime-worldbank/repkit/blob/main/src/dev/reproot-env.yaml) for you to download it and modify it to your needs. +This file can be downloaded from [here](https://github.com/worldbank/repkit/blob/main/src/dev/reproot-env.yaml) for you to download it and modify it to your needs.