Creates a result file with the contents of the input but with a new name. Where possible, this is done without copying the file but instead by simply making a link. While it is possible to run this with a submitted file, the common use will be to change the name of a result file or a previously uploaded file. Note that the original file will still be present in its original location.
Author: David Eby
Many GenePattern modules have trouble with files that have names containing certain special characters - like spaces or slashes - because these characters have special meaning to the programming language or underlying tool used by the module. For example, space characters in filenames can trick the module into cutting the filename short at the point of the space, recognizing "my file.txt" as two items, "my" and "file.txt", rather than one single item. RenameFile gives you a way to give the file a new name without requiring it to be re-uploaded or reprocessed by upstream steps. While it is possible to submit new files directly to RenameFile, it is most useful with files that are already present on the server. RenameFile does not operate on directory inputs.
Strictly speaking, the module does not rename the existing file but instead produces a new file with a different name that has the same content. It uses a filesystem link (a hard link) where possible in order to avoid use of extra disk space, but will create a full copy if linking is not possible. Use the force.copy parameter (off by default) in order to require a new full copy be made.
Use of the screen.filename feature (on by default) will cause the module to attempt to screen many common problematic characters out of the provided filename, replacing them with underscores. Note that this is not an exhaustive list as any particular module can have its own peculiar issues. Instead, this is just a list which the GenePattern team suspects will cause issues. You can completely control the filename by turning off this parameter and providing the desired name to the output.filename parameter, including or omitting any character as desired.
|input file *||Input file to be renamed|
|output filename *||The name to give the output file|
|screen filename *||Automatically screen out problematic characters in the filename|
|force copy *||Force a copy to be made rather than a link.|
* - required
On the Windows platform, filesystem links may not work correctly unless used with NTFS filesystemes on Windows 2000 and newer, with GenePattern set to Run as Administrator. File copies will be made otherwise.
Preprocess & Utilities