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

Documentation on region_type and region_id #16

Open
Rafnuss opened this issue Jan 28, 2020 · 1 comment
Open

Documentation on region_type and region_id #16

Rafnuss opened this issue Jan 28, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Rafnuss
Copy link

Rafnuss commented Jan 28, 2020

The documentation for all extract function () seems to be the same. I suggest we update it to:

#' @param species_ids A character or a vector of characters that represent the id or ids of the species. Example: observer_numbers = '10723' or observer_numbers = c('10723', '40147')
#' @param start_date A character representing the start date from which you want to query the database. It must be in the YYYY-MM-DD format. Defaults to 1 Jan,2019. Example: '2019-01-26'.
#' @param end_date A character representing the end date to which you want to query the database. It must be in the YYYY-MM-DD format. Defaults to 1 Feb, 2019. Example: '2019-02-26'.
#' @param region_type Can take one of the following types: country, province, pentad, group, qdgc. Default is 'country'
#' @param region_id Instantiation (i.e. co-defined with) `region_type`. If the `region_type` = 'country', then the `region_id` must be one of the following: 'kenya', 'southafrica', 'nigeria', 'botswana', 'namibia', 'zimbabwe', 'lesotho', 'swaziland', 'mozambique'. If `region_type` = 'province', then ... . If `region_type` = 'pentad', then  `region_id` is the pentad code (e.g. '3355_1825'). If `region_type` = 'group', then  `region_id` is the group code (e.g. 'BBD'). If `region_type` = 'qdgc', then  `region_id` is the qdgccode (e.g. '???'). Default is 'kenya'.
#' @param return_type There are two options, 'data' and 'count'. 'data' is the actual records submitted to the africa bird map. 'count' return a count of the rows. Default is 'data'

Any idea to improve?

@davidclarance davidclarance added the documentation Improvements or additions to documentation label Jan 28, 2020
@davidclarance
Copy link
Owner

Thanks Raf! Yeah definitely needs to improve. Especially with the examples. Could be a good project for first timers or folks just starting out.

@davidclarance davidclarance added the good first issue Good for newcomers label Jan 28, 2020
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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants