search

forestgeo / forum

Exchange ideas about forestgeo's software
https://forestgeo.github.io/forum/
1 stars 3 forks source link

Ensure that functions are generic enough for across different sites #5

Open ErvanCH opened 7 years ago

ErvanCH commented 7 years ago

Dear Stuart & Mauro,

I am currently wrapping up my code and I am facing difficulties to ensure that it is generic enough to be applied across different sites. Sure it's hard to avoid peculiarities among sites, but it might be worth thinking about possible ways to homogenize functions (i.e. having consistent site name, mnemonic, variables names) and somehow propose some "coding" guideline to potential GIThub users. My 2 cents. Ervan

maurolepore commented 7 years ago

Hi @ervanSTRI,

Thanks for opening this issue. Can you provide an example as described here? Or find me and show me personally.

@maurolepore

maurolepore commented 7 years ago

@ervanSTRI,

RE:

"propose some "coding" guideline"

A coding style that is already very popular among R users is this: http://style.tidyverse.org/. It is the style used in R for Data Science, which I consider the single most useful book for data scientists.

Also, a number of general guidelines are listed here: https://goo.gl/gRPpes. Feel free to add more. Please add the tag "guidelines"; this allows us to filter issues in the learn repository with is:issue is:open label:guideline.

is:issue is:open label:guideline

maurolepore commented 7 years ago

@ervanSTRI,

RE:

I am facing difficulties to ensure that it is generic enough to be applied across different sites. it might be worth thinking about possible ways to homogenize functions (i.e. having consistent site name, mnemonic, variables names)

(Notice I amended the title of this issue to be around this topic; please continue the discussion about guidelines at https://github.com/forestgeo/learn/issues.)

This is a great point. Such "homogeneity" inspired the tidyverse.

The tidyverse is a collection of R packages that share common philosophies and are designed to work together. This site is a work-in-progress guide to the tidyverse and its packages.

The tidiverse inspired me. I adhere to this phylosopy and I'm keen to hear suggestions. For a concrete example, see naming convention of the package stringr (all functions start with str_).