NMinfo function

Get metadata from an NMdata object

Get metadata from an NMdata object

Extract metadata such as info on tables, columns and further details in your favorite class

NMinfo(data, info, as.fun)

Arguments

  • data: An object of class NMdata (a result of NMscanData())
  • info: If not passed, all the metadata is returned. You can use "details", "tables", or "columns" to get only these subsets. If info is "tables" or "columns"
  • as.fun: The default is to return data as a data.frame. Pass a function (say tibble::as_tibble) in as.fun to convert to something else. If data.tables are wanted, use as.fun="data.table". The default can be configured using NMdataConf().

Returns

A table of class as defined by as.fun in case info is "columns" or "tables". A list if info missing or equal to "details".

  • Maintainer: Philip Delff
  • License: MIT + file LICENSE
  • Last published: 2025-03-21