Difference between revisions of "Ieboilsave"
Kbjarkefur (talk | contribs) |
|||
| (8 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
This article is meant to describe use cases, work flow and the reasoning used when developing the commands. For instructions on how to use the command specifically in [[Stata Coding Practices|Stata]] and for a complete list of the options available, see the help files by typing <code>help ieboilsave</code> in Stata. This command is a part of the package [[Stata_Coding_Practices#ietoolkit|ietoolkit]]. To install all the commands in this package, type <code>ssc install ietoolkit</code> in '''Stata'''. | |||
== Read First == | |||
* <code>ieboilsave</code> is still in its beta version, meaning that it's very new and we are using it for experimentation. | |||
* The beta version still works and can be used, however, it might not yet be very useful and new version might include dramatic changes. | |||
* This article describes what the intended use case is, but all functionality might not yet be implemented. | |||
== Intended use cases == | == Intended use cases == | ||
The use case is very similar to [[ieboilstart]] as both commands help the user by including best practice [https://en.wikipedia.org/wiki/Boilerplate_code boilerplate code] without having to type it up manually. Instead of running boilerplate code in the very beginning of a master do-file as ieboilstart does, ieboilsave is meant to be run immediately before saving a | The use case is very similar to [[ieboilstart]] as both commands help the user by including best practice [https://en.wikipedia.org/wiki/Boilerplate_code boilerplate code] without having to type it up manually. Instead of running boilerplate code in the very beginning of a master '''do-file''' as <code>ieboilstart</code> does, <code>ieboilsave</code> is meant to be run immediately before saving a [[Master Dataset|dataset]]. | ||
ieboilsave runs | <code>ieboilsave</code> runs tests that are good practice to run each time before you save a '''dataset''', and it stores meta information about your '''dataset''': when it was last saved, which version of [[Stata Coding Practices|Stata]] was used to create it, which is the [[ID Variable Practices|ID variable]] etc., attached to the '''dataset''' using '''Stata's''' built in [https://www.stata.com/manuals13/pchar.pdf char] command. | ||
ieboilsave tests that the ID variable is still | <code>ieboilsave</code> tests that the '''ID variable''' is still uniquely and fully identifying and can perform tests, for example, that a specified list of '''variables''' have no missing values or are valid dummy '''variables'''. These tests make sure that no changes to the code accidentally invalidate the '''ID variable''', create missing values in '''variables''' that should never be missing, etc. | ||
For a complete list | For a complete list of tests that <code>ieboilsave</code> can perform, see the help file in '''Stata'''. | ||
== Instructions == | == Instructions == | ||
These instructions are meant to help you understand how to use the command. For technical instructions on how to implement the command in Stata see the help files by typing <code>help ieboilsave</code> in Stata. | These instructions are meant to help you understand how to use the command. For technical instructions on how to implement the command in [[Stata Coding Practices|Stata]] see the help files by typing <code>help ieboilsave</code> in '''Stata'''. | ||
Run ieboilsave on the line immediately before you save the | Run <code>ieboilsave</code> on the line immediately before you save the [[Master Dataset|dataset]]. <code>ieboilsave</code> is meant to be used before saving '''datasets''' to be used for [[Data Analysis|analysis]] and [[Dissemination|dissemination]]. It is probably not worth the effort to use <code>ieboilsave</code> before each intermediate '''dataset''' that you save for your own convenience. | ||
== | == Related Pages == | ||
[[Special:WhatLinksHere/Ieboilsave|Click here to see pages that link to this topic]]. | |||
[[Category: | [[Category: Software Tools]] | ||
Latest revision as of 15:21, 9 August 2023
This article is meant to describe use cases, work flow and the reasoning used when developing the commands. For instructions on how to use the command specifically in Stata and for a complete list of the options available, see the help files by typing help ieboilsave in Stata. This command is a part of the package ietoolkit. To install all the commands in this package, type ssc install ietoolkit in Stata.
Read First
ieboilsaveis still in its beta version, meaning that it's very new and we are using it for experimentation.- The beta version still works and can be used, however, it might not yet be very useful and new version might include dramatic changes.
- This article describes what the intended use case is, but all functionality might not yet be implemented.
Intended use cases
The use case is very similar to ieboilstart as both commands help the user by including best practice boilerplate code without having to type it up manually. Instead of running boilerplate code in the very beginning of a master do-file as ieboilstart does, ieboilsave is meant to be run immediately before saving a dataset.
ieboilsave runs tests that are good practice to run each time before you save a dataset, and it stores meta information about your dataset: when it was last saved, which version of Stata was used to create it, which is the ID variable etc., attached to the dataset using Stata's built in char command.
ieboilsave tests that the ID variable is still uniquely and fully identifying and can perform tests, for example, that a specified list of variables have no missing values or are valid dummy variables. These tests make sure that no changes to the code accidentally invalidate the ID variable, create missing values in variables that should never be missing, etc.
For a complete list of tests that ieboilsave can perform, see the help file in Stata.
Instructions
These instructions are meant to help you understand how to use the command. For technical instructions on how to implement the command in Stata see the help files by typing help ieboilsave in Stata.
Run ieboilsave on the line immediately before you save the dataset. ieboilsave is meant to be used before saving datasets to be used for analysis and dissemination. It is probably not worth the effort to use ieboilsave before each intermediate dataset that you save for your own convenience.