Forget the location of a dependency program

unset_program() forgets the location that set_program() saved for a program. After that, find_ffmpeg() and the other find_*() functions look for the program on the PATH only.

Usage

unset_program(program)

Arguments

program

A string naming the program to forget. One of "ffmpeg", "ffprobe", "ffplay" or "mediainfo". There is no default, because the call deletes a file. A call that names no program gives an error.

Value

Invisibly, TRUE when the call removed a saved location or an empty folder, and FALSE when there was nothing to remove.

Details

The call deletes the file that holds the location. It does not ask you to confirm first. It does not remove the program, and it does not change the PATH. A program on the PATH is still found afterwards.

If no location is saved for the program, the call gives a warning and returns FALSE. It does not give an error, because the program is already forgotten.

The call also clears a location saved by a version before 0.2.0. See the section "Locations saved by earlier versions" in find_ffmpeg().

A folder can be where a location file goes, in the current folder or the one before 0.2.0. If the folder is empty, the call removes it with the files. A folder counts as empty only when it holds nothing, not even a hidden file or an empty folder, and a folder the package cannot read never counts as empty. A folder that is not empty stays. The call removes the file or the empty folder at the other path, and then gives a tidymedia_location_folder_kept warning. The warning names the folder that stays in its message and in tm_files. If the removal at the other path fails, the call gives a tidymedia_location_not_removed error in place of the warning. That error names what the call could not remove in its message and in tm_files, and its message also names the folder that the call kept. If each path that holds something holds a folder that is not empty, the call gives a tidymedia_location_folder error and removes nothing. The error lists each such folder in its message and in tm_files. Delete those folders by hand, then call again.

See also

set_program() to save a location, and program_status() to see where the package finds each program.

Other program management functions: find_ffmpeg(), install_on_win(), program_status(), set_program()

Examples

if (FALSE) { # \dontrun{
# Forget a location set_program() remembered, so that find_mediainfo() goes
# back to answering from the PATH
unset_program("mediainfo")
} # }