read_package_configuration: Read information from project configuration file...
In CAPLTER/capeml: CAP LTER package for generating EML
View source: R/read_package_configuration.R
read_package_configuration R Documentation
Read information from project configuration file ("config.yaml")
Description
The read_package_configuration function reads the project
configuration details from the config.yaml file that must exist in the
working directory. This is a internal, convenience function intended mostly
for the utility of other capeml functions but read_package_configuration can
be run independenty.
Usage
read_package_configuration()
Value
A list of configuration details.
Note
This function if a bit of overkill in the sense that other capeml
functions (e.g., create_dataTable) could eaisily access the configuration
details by reading the config.yaml file. The purpose here is mostly to
accommodate the evolving structure of the config.yaml structure. For
example, capeml formerly took a projectIdentifier that featured scope +
dataset number + version. Logic is included here to accommodate older and
newer config.yaml styles; this logic is better encapsulated into this single
function rather than every place configuration details are accessed.
CAPLTER/capeml documentation built on April 3, 2024, 11:17 p.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_package_configuration.R
| read_package_configuration | R Documentation |
Read information from project configuration file ("config.yaml")
Description
The read_package_configuration function reads the project configuration details from the config.yaml file that must exist in the working directory. This is a internal, convenience function intended mostly for the utility of other capeml functions but read_package_configuration can be run independenty.
Usage
read_package_configuration()
Value
A list of configuration details.
Note
This function if a bit of overkill in the sense that other capeml functions (e.g., create_dataTable) could eaisily access the configuration details by reading the config.yaml file. The purpose here is mostly to accommodate the evolving structure of the config.yaml structure. For example, capeml formerly took a projectIdentifier that featured scope + dataset number + version. Logic is included here to accommodate older and newer config.yaml styles; this logic is better encapsulated into this single function rather than every place configuration details are accessed.
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.