search

lhenneman / hyspdisp

4 stars 4 forks source link

Make several vignettes #40

Closed schoolAccountMajaG closed 4 years ago

schoolAccountMajaG commented 5 years ago

@lhenneman What do you think about having several vignettes.

I would suggest:

  1. Data download
  2. Analysis
  3. Advanced data download (for different data sets, so that the user knows how we preprocess the data inside the functions).
lhenneman commented 5 years ago

I'm okay with this. Is there a way to link the vignette to the next one, so it's easy to pass through the entire tutorial?

On Tue, Jun 18, 2019 at 8:14 AM Maja notifications@github.com wrote:

@lhenneman https://github.com/lhenneman What do you think about having several vignettes.

I would suggest:

  1. Data download
  2. Analysis
  3. Advanced data download (for different data sets, so that the user knows how we preprocess the data inside the functions).

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/lhenneman/hyspdisp/issues/40?email_source=notifications&email_token=AHMZYWYYM4F5FA6EU3ORB4LP3DGSVA5CNFSM4HY7MT5KYY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4G2EB27A, or mute the thread https://github.com/notifications/unsubscribe-auth/AHMZYW44SRQTKNA6CZTWV6DP3DGSVANCNFSM4HY7MT5A .

-- Lucas R.F. Henneman, Ph.D. (404) 788-2161 lhenneman@gmail.com

schoolAccountMajaG commented 5 years ago

Well, what we could also do is make one with different chapters. Like a book.

lhenneman commented 5 years ago

Sounds good. I'm on board.

On Tue, Jun 18, 2019 at 8:22 AM Maja notifications@github.com wrote:

Well, what we could also do is make one with different chapters. Like a book.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/lhenneman/hyspdisp/issues/40?email_source=notifications&email_token=AHMZYWYZCFC2AMMKMVQNC2LP3DHRJA5CNFSM4HY7MT5KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODX6GKLQ#issuecomment-503080238, or mute the thread https://github.com/notifications/unsubscribe-auth/AHMZYWZHKEW6JCSWHMVRVALP3DHRJANCNFSM4HY7MT5A .

-- Lucas R.F. Henneman, Ph.D. (404) 788-2161 lhenneman@gmail.com

cchoirat commented 5 years ago

@garbulinskamaja Can you please elaborate on the difference between 1 and 3?

schoolAccountMajaG commented 5 years ago

Yes, the first vignette (1) would explain how to download data using the function that we set up that contains all the links etc. In my mind, that function will take several arguments like: datatype, years,...

The user will be able to download data one by one, but the output will be preprocessed and ready for a run in the model.

The third one (3) will explain how we made (1) work. We will explain what is inside our download_data function so that the user can easily download data that we do not provide. Let's say, about a different country. The vignette will also show all the preprocessing that was done in (1).

What do you think?

schoolAccountMajaG commented 4 years ago

The main vignette has been created together with some additional vignettes that explain how to get the data processed to the format that is available in the disperseR package