read_attributes_file: Load attribute information from a entity attribute yaml or...
In CAPLTER/capeml: CAP LTER package for generating EML
View source: R/read_attributes_file.R
read_attributes_file R Documentation
Load attribute information from a entity attribute yaml or csv file
Description
The read_attributes_file function reads an entity's
attribute details from a "entity name"_attrs.yaml or "entity name"_attrs.csv
file in the working directory - the details of which are incorporated into
the EML metadata for that entity.
Usage
read_attributes_file(string_pointer, entity_id)
Arguments
string_pointer
(character) The quoted name of the data entity.
entity_id
(character) Quoted identifier of the data object that is being described,
this will usually be the name or hash of the data table (or otherwise) of
which the attribute is associated.
Details
The read_attributes_file function reads an entity's
attribute details from a "entity name"_attrs.yaml or "entity name"_attrs.csv
file in the working directory - the details of which are incorporated into
the EML metadata for that entity.
Value
A list of a list of attributes and column classes
Note
Recent versions of the capeml package generate attribute (and factor)
metadata files in yaml format; the read_attributes_file function will
look also for attributes files in csv format to accommodate older projects.
The read_attributes_file function is intended primarily as a
helper to other functions in the capeml ecosystem (notably
read_attributes and read_raster_attributes) so is not meant to
be called directly (but can be).
CAPLTER/capeml documentation built on Dec. 23, 2024, 6:29 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.
View source: R/read_attributes_file.R
| read_attributes_file | R Documentation |
Load attribute information from a entity attribute yaml or csv file
Description
The read_attributes_file function reads an entity's
attribute details from a "entity name"_attrs.yaml or "entity name"_attrs.csv
file in the working directory - the details of which are incorporated into
the EML metadata for that entity.
Usage
read_attributes_file(string_pointer, entity_id)
Arguments
string_pointer |
(character) The quoted name of the data entity. |
entity_id |
(character) Quoted identifier of the data object that is being described, this will usually be the name or hash of the data table (or otherwise) of which the attribute is associated. |
Details
The read_attributes_file function reads an entity's
attribute details from a "entity name"_attrs.yaml or "entity name"_attrs.csv
file in the working directory - the details of which are incorporated into
the EML metadata for that entity.
Value
A list of a list of attributes and column classes
Note
Recent versions of the capeml package generate attribute (and factor)
metadata files in yaml format; the read_attributes_file function will
look also for attributes files in csv format to accommodate older projects.
The read_attributes_file function is intended primarily as a
helper to other functions in the capeml ecosystem (notably
read_attributes and read_raster_attributes) so is not meant to
be called directly (but can be).
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.