exportCohortDefinitionSet() should be called getCohortDefinitionSet()

[schuemie]

I think the exportCohortDefinitionSet() function should be called getCohortDefinitionSet(), since the function doesn't export anything. It just gets information from WebAPI, similar to for example getCohortDefinition().

[ablack3]

Are there recommendations for the consistent use of generic verbs like "get", "export", "create", "write", "read", "save", "load" across Hades?
For example, "get" implies retrieving records from a database into R.

[schuemie]

Hmmm, it would be nice if such recommendations existed, but they don't. I was merely pointing out that, in this particular case,
'export' seemed inconsistent with the verbs used in this package itself.

My personal interpretation of verbs:

• get: retrieve an object or value from somewhere (could be memory, a database, an API, an SFTP server).
• set: set a value in memory.
• put: upload a value to an API or SFTP server.
• insert: upload data to a database.
• load: load an object from the local file system.
• save: save an object to the local file system.
• create: create some object.
• compute: compute a value.
• fit: a specific type of compute, where we fit a model to data.
• plot: create a plot (usually with an option to write it to the local filesystem).
• run: perform a series of pre-specified steps.
• is: return a true/false answer about a state.
• import: get an object from another programming environment. (e.g. import a Python object into R)
• export: the reverse of 'import'.

I never really use 'read', or 'write' for some reason.

[ablack3]

I like your interpretation. This discussion should perhaps be in a different thread since it is a cross-hades topic. I think the steps would be 1) compile a list of all hades functions 2) look for commonly used verbs 3) identify inconsistencies in how they are used. It might be that there is already clear usage. I know Capr has a lot of create____ functions and I was thinking about the possibility of omitting the create verb in some cases. For example we use data.frame() instead of create.data.frame().