search

dfo-mar-mpas / MarConsNetData

Code that facilitates the acquisition of data for the Maritimes Conservation Network
https://dfo-mar-mpas.github.io/MarConsNetData/
0 stars 0 forks source link

Create table in vignette that links ids and titles #2

Closed j-harbin closed 1 month ago

j-harbin commented 4 months ago

As @remi-daigle pointed out, my getData function, which currently requires a id from the PPT to acquire data, will be problematic for those projects that came before the PPT or those that are external, etc. To address this issue, we talked about creating a table in the vignette that has the following column names:

id an id from the PPT title a name of a project. This would be an option for both projects in the PPT in those that are not function name of the subset function you call. (e.g. get_snowCrab) - This will also be a hyperlink to the help docs for that function source a vector indicating if the data source is external or internal

j-harbin commented 4 months ago

I am thinking this should instead be a data that is loaded in the package (and presented in the vignette). This will also allow functions to use the table as a look up table and will eliminate hard coding.

j-harbin commented 1 month ago

This has been done and is called dataTable in the package.