Skip to content

Commit 2207545

Browse files
committed
fix
1 parent 8568a73 commit 2207545

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@ to order tasks and track whether they are up-to-date. pytask-stata offers two mo
115115
pass these paths and other task data to the Stata script.
116116

117117
1. Use the default YAML configuration file. This is the recommended mode if your Stata
118-
installation can use the user-written `yaml` package.
118+
installation can use the user-written [`yaml`](https://github.com/jpazvd/yaml)
119+
package, which is compatible with Stata 14+.
119120
1. Use the `options` argument of the decorator to pass command line arguments. This is
120121
the compatibility mode for Stata installations where `yaml.ado` is not available or
121122
not supported.
@@ -128,7 +129,11 @@ a YAML configuration file.
128129

129130
By default, pytask-stata serializes all task keyword arguments and passes the path to
130131
the generated YAML file as the first argument to the do-file. To read the file inside
131-
Stata, install the user-written `yaml` package.
132+
Stata, install the user-written [`yaml`](https://github.com/jpazvd/yaml) package, which
133+
is compatible with Stata 14+.
134+
135+
See [YAML Data Passed to Stata](docs/yaml.md) for the supported data types and how they
136+
are represented in Stata.
132137

133138
```stata
134139
ssc install yaml
@@ -215,7 +220,7 @@ def task_run_do_file(produces: Path = BLD / "auto.dta"):
215220
### Repeating tasks with different scripts or inputs
216221

217222
You can also parametrize the execution of scripts, meaning executing multiple do-files
218-
as well as passing different command line arguments to the same do-file.
223+
as well as passing different inputs or task data to the same do-file.
219224

220225
The following task executes two do-files which produce different outputs.
221226

0 commit comments

Comments
 (0)