FilenameMapper-class: Make sure to call $readMappingFile(some_file) if you want to...
In PTXQC: Quality Report Generation for MaxQuant and mzTab Results
FilenameMapper-class R Documentation
Make sure to call $readMappingFile(some_file) if you want to support a user-defined file mapping.
Otherwise, calls to $getShortNames() will create/augment the mapping for filenames.
Description
Make sure to call $readMappingFile(some_file) if you want to support a user-defined file mapping.
Otherwise, calls to $getShortNames() will create/augment the mapping for filenames.
Fields
raw_file_mappingData.frame with columns 'from', 'to' and maybe 'best.effort' (if shorting was unsuccessful)
mapping.creationhow the current mapping was obtained (user or auto)
external.mapping.fileFilename of user-defined mapping file; only defined if readMappingFile() was called
Methods
getShortNamesStatic(raw.files, max_len, fallbackStartNr = 1)Static method: Shorten a set of Raw file names and return a data frame with the mappings.
Mapping will have: $from, $to and optionally $best.effort (if shorting was unsuccessful and numbers had to be used)
raw.files Vector of Raw files.
max_len Maximal length of shortening results, before resorting to canonical names (file 1,...).
fallbackStartNr Starting index for canonical names.
Return Value
data.frame with mapping.
Examples
a = FilenameMapper$new()
a$readMappingFile('filenamemapping.txt')
PTXQC documentation built on May 29, 2024, 9:26 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| FilenameMapper-class | R Documentation |
Make sure to call $readMappingFile(some_file) if you want to support a user-defined file mapping. Otherwise, calls to $getShortNames() will create/augment the mapping for filenames.
Description
Make sure to call $readMappingFile(some_file) if you want to support a user-defined file mapping. Otherwise, calls to $getShortNames() will create/augment the mapping for filenames.
Fields
raw_file_mappingData.frame with columns 'from', 'to' and maybe 'best.effort' (if shorting was unsuccessful)
mapping.creationhow the current mapping was obtained (user or auto)
external.mapping.fileFilename of user-defined mapping file; only defined if readMappingFile() was called
Methods
getShortNamesStatic(raw.files, max_len, fallbackStartNr = 1)Static method: Shorten a set of Raw file names and return a data frame with the mappings. Mapping will have: $from, $to and optionally $best.effort (if shorting was unsuccessful and numbers had to be used)
raw.filesVector of Raw files.max_lenMaximal length of shortening results, before resorting to canonical names (file 1,...).fallbackStartNrStarting index for canonical names.
Return Value
data.frame with mapping.
Examples
a = FilenameMapper$new()
a$readMappingFile('filenamemapping.txt')
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.