search

project-gen3sis / R-package

Repository of the R-packageGen3sis
https://project-gen3sis.github.io/R-package/
GNU General Public License v3.0
29 stars 9 forks source link

Why so many vignettes? #4

Closed florianhartig closed 4 years ago

florianhartig commented 4 years ago

@ohagen - is there are special reason why we wouldn't put everything in the same vignette?

ohagen commented 4 years ago

The idea is to have an introduction vignette very simple to make the user confortable with the main structure. Then one for creating landscapes and one for creating configs. Then, a few with diferente examples or in this case just a long one. No strong preference.

florianhartig commented 4 years ago

hm ... I would imagine it's easier for the user to have a single long vignette. Short examples about how to use the functions are imo better in the function and package help

ohagen commented 4 years ago

I see your point. The problem is that there are long complex examples for the landscapes creating case. With many conversions and use of other package functions before entering our package.

ohagen commented 4 years ago

We can start like this now and see if we can make a nice long one at the end. Different people will work on different files now