Skip to content

Commit

Permalink
updates following transfer to worldbank account
Browse files Browse the repository at this point in the history
  • Loading branch information
kbjarkefur committed Feb 21, 2024
1 parent 929631f commit 3ad6235
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 21 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/ado/repkit.ado
Original file line number Diff line number Diff line change
Expand Up @@ -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}"
}
Expand Down
2 changes: 1 addition & 1 deletion src/mdhlp/repado.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/mdhlp/repkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/mdhlp/reprun.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions src/repkit.pkg
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
* 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
*** stata
d Version: Stata 14.1
d
*** author
d Author: DIME Analytics
d Author: DIME Analytics, LSMS Team
*** contact
d Contact: [email protected]
d Contact: dimeanalytics@@worldbank.org, lsms@@worldbank.org
*** url
d URL: https://github.com/worldbank/repkit
d
Expand Down
2 changes: 1 addition & 1 deletion src/tests/reprun/with-ado-folder/main.do
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/vignettes/ado-management-with-repado.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions src/vignettes/reproot-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

0 comments on commit 3ad6235

Please sign in to comment.