Browse Source

add additional notes on run options

Elena Piscopia 4 years ago
parent
commit
2df646c7cc
1 changed files with 5 additions and 0 deletions
  1. 5 0
      notes.txt

+ 5 - 0
notes.txt

@@ -25,3 +25,8 @@ in datalad rerun CHECKSUM. DataLad will take information from the run record of
 commit, and re-execute it. If no changes happen with a rerun, the command will not be written
 to history. Note: you can also rerun a datalad rerun command!
 
+You should specify all files that a command takes as input with an -i/--input flag. These
+files will be retrieved prior to the command execution. Any content that is modified or
+produced by the command should be specified with an -o/--output flag. Upon a run or rerun
+of the command, the contents of these files will get unlocked so that they can be modified.
+