Difference between revisions of "Retrieve file.m"
(Fix lead description from MATLAB header (folding/hyphenation pass)) |
(Sync syntax/arguments/outputs with current Spinach source) |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:retrieve_file.m}} __NOTOC__ | {{DISPLAYTITLE:retrieve_file.m}} __NOTOC__ | ||
| + | |||
Retrieves a file from an HTTPS link and stores it in a user-specified directory. | Retrieves a file from an HTTPS link and stores it in a user-specified directory. | ||
==Syntax== | ==Syntax== | ||
| − | + | retrieve_file(file_url,file_name,dest_dir) | |
==Arguments== | ==Arguments== | ||
| − | + | file_url - HTTPS URL pointing to the file to retrieve | |
file_name - name of the file to be stored on disk | file_name - name of the file to be stored on disk | ||
dest_dir - destination directory for the downloaded file | dest_dir - destination directory for the downloaded file | ||
| Line 14: | Line 15: | ||
==Outputs== | ==Outputs== | ||
| − | + | file_path - full path to the retrieved file | |
==Examples== | ==Examples== | ||
| + | |||
See examples in the Spinach distribution relevant to this function. | See examples in the Spinach distribution relevant to this function. | ||
==Notes== | ==Notes== | ||
| + | |||
This page was generated from the function header in the Spinach repository. | This page was generated from the function header in the Spinach repository. | ||
==See also== | ==See also== | ||
| + | |||
* [[spinach2hiper.m]] | * [[spinach2hiper.m]] | ||
* [[Import,_export,_and_visualisation]] | * [[Import,_export,_and_visualisation]] | ||
Revision as of 15:04, 5 April 2026
Retrieves a file from an HTTPS link and stores it in a user-specified directory.
Syntax
retrieve_file(file_url,file_name,dest_dir)
Arguments
file_url - HTTPS URL pointing to the file to retrieve
file_name - name of the file to be stored on disk
dest_dir - destination directory for the downloaded file
Outputs
file_path - full path to the retrieved file
Examples
See examples in the Spinach distribution relevant to this function.
Notes
This page was generated from the function header in the Spinach repository.
See also
- spinach2hiper.m
- Import,_export,_and_visualisation
- Installation
- Matlab_configuration_advice
- Main_Page
- Kernel_utilities
Version 2.11, authors: Ilya Kuprov
