R/write.metadata.R

In BoutrosLab.plotting.general: Functions to Create Publication-Quality Plots

# The BoutrosLab.plotting.general package is copyright (c) 2013 Ontario Institute for Cancer Research (OICR)
# This package and its accompanying libraries is free software; you can redistribute it and/or modify it under the terms of the GPL
# (either version 1, or at your option, any later version) or the Artistic License 2.0.  Refer to LICENSE for the full license text.
# OICR makes no representations whatsoever as to the SOFTWARE contained herein.  It is experimental in nature and is provided WITHOUT
# WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR ANY OTHER WARRANTY, EXPRESS OR IMPLIED. OICR MAKES NO REPRESENTATION
# OR WARRANTY THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT OR OTHER PROPRIETARY RIGHT.
# By downloading this SOFTWARE, your Institution hereby indemnifies OICR against any loss, claim, damage or liability, of whatsoever kind or
# nature, which may arise from your Institution's respective use, handling or storage of the SOFTWARE.
# If publications result from research using this SOFTWARE, we ask that the Ontario Institute for Cancer Research be acknowledged and/or
# credit be given to OICR scientists, as scientifically appropriate.

### FUNCTION TO WRITE METADATA ####################################################################
write.metadata <- function(filename = NULL, description = NULL, verbose = FALSE) {

	exiftool.location <- Sys.which('exiftool');

	# whether to output stuff or not
	if (FALSE == verbose) {
		standard.out <- NULL;
		}
	else {
		standard.out <- '';
		}

	# write metadata only if file exists and exiftool has been installed
	if (!is.null(filename) && exiftool.location != '') {

		# retrieve software versions
		R.version <- getRversion();

		lattice.version			<- packageVersion('lattice');
		lattice.extra.version		<- packageVersion('latticeExtra');
		plotting.general.version 	<- packageVersion('BoutrosLab.plotting.general');
		plotting.survival.version <- tryCatch({
			packageVersion('BoutrosLab.plotting.survival');
			}, error = function(e) {
			'unknown';
			});

		software.versions = paste0(
			'R ',
			R.version,
			' | lattice ',
			lattice.version,
			' | latticeExtra ',
			lattice.extra.version,
			' | BL.plotting.general ',
			plotting.general.version,
			' | BL.plotting.survival ',
			plotting.survival.version
			);

		# retrieve computer information
		operating.system <- paste(Sys.info()[['sysname']], Sys.info()[['version']], collapse = ' ');
		machine <- Sys.info()[['machine']];

		# retrieve username
		author <- Sys.info()[['user']];

		# write author, software, description of figure,
		# os info & hardware info
		system2(
			'exiftool',
			args = paste0(
				'-Author="',
				author,
				'" -Software="',
				software.versions,
				'" -ImageDescription="',
				description,
				'" -HostComputer="',
				operating.system,
				'" -Make="',
				machine,
				'" -overwrite_original ',
				filename
				),
			stdout = standard.out
			);
		}
	}