*! version 1.0.1 Matthew White 09mar2015

Title

dtanotes -- Add metadata as dataset notes

Syntax

Add dtanotes notes

dtanotes, creator(string) [nogit]

Drop dtanotes notes

dtanotes drop

Description

dtanotes adds useful metadata as dataset notes:

o Creating do-file or process

o Current date and time

o Names of computer and user

o Data signature

o Git SHA-1 hash of the current commit

o Git working tree status

o Git uncommitted changes, including untracked files and
directories

dtanotes also labels the dataset with
"See notes." so that the notes are not overlooked.

dtanotes drop drops dtanotes notes.

Options for dtanotes

creator(string) is required and specifies the name of the do-file or
process that created the dataset.

nogit specifies that dtanotes not add information about
a Git repository to notes.

Remarks

dtanotes drops previous dtanotes notes before adding new ones.
It resets the data signature before adding it to notes.

Because dtanotes adds information about a Git repository to notes,
the SSC program stgit is required. The working directory should be set to
the repository that contains the code that created the dataset.
If the project does not use Git, specify option nogit when adding notes.

The GitHub repository for dtanotes is
here.

Author

Matthew White

For questions or suggestions, submit a
GitHub issue
or e-mail researchsupport@poverty-action.org.

Also see

Help: [D] notes, [D] datasignature

User-written: stgit