diff --git a/tmd/README.md b/tmd/README.md index 71266286..d870bbc6 100644 --- a/tmd/README.md +++ b/tmd/README.md @@ -1,8 +1,9 @@ -# tax_microdata_benchmarking +# tmd : tax_microdata -This module contains four submodules: +This package has five submodules: -* datasets: contains code defining generation functions for the datasets used in the benchmarking. -* examination: contains code and assets for examining the performance of the benchmarked datasets. -* storage: a folder housing input data and output data created by this package. -* utils: contains utility functions used in the benchmarking process that aren't specific to one dataset. +* datasets: contains code for generating national datasets used in the benchmarking. +* examination: contains code for examining the quality of the national datasets. +* storage: contains national input and output data created by this package. +* utils: contains utility functions that aren't specific to one dataset. +* areas: contains code for generating sub-national area weights and examining their quality. diff --git a/tmd/areas/README.md b/tmd/areas/README.md new file mode 100644 index 00000000..2ed0661d --- /dev/null +++ b/tmd/areas/README.md @@ -0,0 +1,6 @@ +# areas + +Contains code and data used to generate sub-national area weights +files that can be used with the national input data and national +growfactors files, and code to examine the quality of the area +weights. diff --git a/tmd/areas/targets/README.md b/tmd/areas/targets/README.md index 60e0af2c..4f06b376 100644 --- a/tmd/areas/targets/README.md +++ b/tmd/areas/targets/README.md @@ -1 +1,3 @@ -# AREA TARGET FILES \ No newline at end of file +# areas / targets + +Contains sub-national area targets files. diff --git a/tmd/areas/weights/README.md b/tmd/areas/weights/README.md index 680eae6d..ec029aa5 100644 --- a/tmd/areas/weights/README.md +++ b/tmd/areas/weights/README.md @@ -1 +1,3 @@ -# AREA WEIGHTS FILES \ No newline at end of file +# areas / weights + +Contains sub-national area weights files. diff --git a/tmd/examination/README.md b/tmd/examination/README.md new file mode 100644 index 00000000..80842f51 --- /dev/null +++ b/tmd/examination/README.md @@ -0,0 +1,5 @@ +# examination + +Examines the quality of national datasets by comparing tax-expenditure +estimates generated using the datasets with tax-expenditures estimates +published by federal agencies. diff --git a/tmd/storage/README.md b/tmd/storage/README.md new file mode 100644 index 00000000..172ee7cb --- /dev/null +++ b/tmd/storage/README.md @@ -0,0 +1,3 @@ +# storage + +Contains national input data and output data generated by this package. diff --git a/tmd/utils/README.md b/tmd/utils/README.md index cf53f80c..68fd240b 100644 --- a/tmd/utils/README.md +++ b/tmd/utils/README.md @@ -1,3 +1,4 @@ # utils -This folder contains utility functions that are used in the project, but aren't specific to any one dataset (i.e. are reusable between flat files). +This folder contains utility functions that are used in the project, +but aren't specific to any one dataset.