Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Needed: documentation on geohydrological variables & settings #47

Open
florisvdh opened this issue Mar 20, 2020 · 0 comments
Open

Needed: documentation on geohydrological variables & settings #47

florisvdh opened this issue Mar 20, 2020 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@florisvdh
Copy link
Member

Function documentation of get_locs(), get_xg3() and get_chem() still needs explanation of geohydrological and some Watina-specific terms. This is to be added. The aim is to give just enough information to someone with general (non-Dutch) geohydrological background in order to understand the meaning of e.g. "VLD", "ENT", ..., "P", "S", "R", ..., filterdepth, measuringref_ost, ... HG3, LG3, VG3, vg3_lcl, hydroyear, ..., loq, chem_variable, ...

In several places in R/get.R reminders are present where function documentation needs improvement (grep-output at e24d68b):

11:#' (TO BE ADDED: Explanation on the different available values of loc_type
12-#' and loc_validity)
--
188:#' (TO BE ADDED: Explanation on the variable names of the returned object)
--
696:#' (TO BE ADDED: What are XG3 values? What is a hydroyear?
697-#' Why truncate, and why truncate by default?
698-#' When to choose which \code{vert_crs}?)
--
732:#' (TO BE ADDED: Explanation on the variable names of the returned object)
--
902:#' TO BE ADDED: What is electroneutrality and why is it used as a criterion?
--
973:#' (TO BE ADDED: Explanation on the variable names of the returned object)
974-#'
975:#' (TO BE ADDED: Explanation on the different abbreviations in the column
976-#' 'chem_variable')

See development guidelines for practical information. Specific notes:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants