Difference between revisions of "CurrentDataFolder"

Latest revision as of 04:24, 4 March 2021

CurrentDataFolder(directoryPath)

The current data folder is the default directory for reading or storing data by functions such as ReadTextFile(), WriteTextFile(), and SpreadsheetOpen(). If you specify relative paths as parameters to these functions, they interpret them as relatvie to this folder.

With no parameters, CurrentDataFolder(), returns the full path for the current data directory.

With one parameter, CurrentDataFolder(«directoryPath»), sets the current data folder to «directoryPath», which may be relative to the current folder or a full path. Given a valid path, it returns the new full path to the current data folder.

If you change the folder in an open or save file dialog from a file read or write function, it will change the current data folder.

There is also a current model folder, accessed with CurrentModelFolder(), that is the default directory for saving and loading models and modules. When you start a model, CurrentDataFolder is set, by default, to the current model folder. But the current data and model folders may change separately thereafter.

History

CurrentDataFolder() is new to Analytica 4.6. But in Analytica 4.5 and earlier, the same function exists as CurrentDataDirectory().

@@ Line 1: / Line 1: @@
 [[Category:System Functions]]
+[[Category:File system functions]]
 [[Category:Doc Status C]] <!-- For Lumina use, do not change -->
-''new to [[Analytica 4.6]]. But in [[Analytica 4.5]] and earlier, the same function exists as <code>[[CurrentDataDirectory]]()</code>.
-The current data folder is the default path for loading or storing data.  Relative files paths are interpreted relative to this folder (directory).  File dialogs for data (e.g., export, import) will appear initially in this folder, and functions such as [[ReadTextFile]], [[WriteTextFile]], or [[NlpDefine]]'s trace file treat their filename parameter as relative to the current data folder.
+==CurrentDataFolder(''directoryPath'')==
-Changing folders in a open or save file dialog may change the current data folder.
+The current data folder is the default directory for reading or storing data by functions such as [[ReadTextFile]](), [[WriteTextFile]](), and [[SpreadsheetOpen]]().  If you specify relative paths as parameters to these functions, they interpret them as relatvie to this folder.
-Analytica also has a [[CurrentModelFolder]], which determines the default path for saving an loading models and modules.  When a model is loaded, the [[CurrentDataFolder]] is set, by default, to the current model folder.  The two may changed separately.
+With no parameters, [[CurrentDataFolder]](), returns the full path for the current data directory.
-The call with no parameters:
+With one parameter, [[CurrentDataFolder]](«directoryPath»), sets the current data folder to «directoryPath», which may be relative to the current folder or a full path. Given a valid path, it returns the new full path to the current data folder.
- [[CurrentDataFolder]]()
-returns the full path for the current data directory.
-The call with one parameter:
+If you change the folder in an open or save file dialog from a file read or write function, it will change the current data folder.
- [[CurrentDataFolder]](directoryPath)
-sets the current data folder to the indicated path (if valid), and returns the full path of the current data folder afterwards.  The parameter can be a relative path, but the full path is returned.
-= Declaration =
+There is also a current model folder, accessed with [[CurrentModelFolder]](), that is the default directory for saving and loading models and modules.  When you start a model, [[CurrentDataFolder]] is set, by default, to the current model folder.  But the current data and model folders may change separately thereafter.
- [[CurrentDataFolder]](folder: Optional Text Atomic)
+==History==
+[[CurrentDataFolder]]() is new to [[Analytica 4.6]]. But in [[Analytica 4.5]] and earlier, the same function exists as [[CurrentDataDirectory]]().
-= See also =
+== See also ==
 * [[CurrentModelFolder]]
-* [[ReadTextFile]], [[ReadCsvFile]]
+* [[CurrentDataDirectory]]
+* [[ReadTextFile]]
+* [[ReadCsvFile]]
 * [[WriteTextFile]]
 * [[NlpDefine]]