File: readDirectory-doc.m2

package info (click to toggle)
macaulay2 1.17.1%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 68,376 kB
  • sloc: cpp: 102,995; ansic: 10,040; javascript: 6,019; sh: 3,506; makefile: 3,426; lisp: 727; yacc: 590; perl: 369; xml: 177; python: 141; lex: 65; awk: 3
file content (20 lines) | stat: -rw-r--r-- 595 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
--- status: TODO
--- author(s): 
--- notes: 

document { 
     Key => readDirectory,
     Headline => "read the contents of a directory",
     Usage => "readDirectory dir",
     Inputs => { "dir" => String => "a filename or path to a directory" },
     Outputs => { List => "the list of filenames stored in the directory" },
     EXAMPLE lines ///
     	  dir = temporaryFileName()
	  makeDirectory dir
	  (fn = dir | "/" | "foo") << "hi there" << close
	  readDirectory dir
	  removeFile fn
	  removeDirectory dir
     ///,
     SeeAlso => { removeDirectory, removeFile, makeDirectory }
     }