Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a full end-to-end example for one dataset #18

Open
lawinslow opened this issue Mar 18, 2014 · 6 comments
Open

Create a full end-to-end example for one dataset #18

lawinslow opened this issue Mar 18, 2014 · 6 comments

Comments

@lawinslow
Copy link
Member

A great starting model would be metab.bookkeep.

The code would

  1. Load data
  2. supply data to a model
  3. retrieve and plot the output metabolism parameters.

To see how to load data out of the "inst/extdata" folder, see the timeseries function, like ts.wedderburn.number, in rLakeAnalyzer.
http://cran.r-project.org/web/packages/rLakeAnalyzer/rLakeAnalyzer.pdf

A great place to put it would be here:
https://github.com/GLEON/LakeMetabolizer/blob/master/inst/manuscript.script.R

@rBatt
Copy link
Contributor

rBatt commented Mar 18, 2014

I've done some of this (see ryanData.R) – I suggest we load .RData files with the package for the demos. The .RData files would, e.g., have objects containing a matrix of 1 day of data from each lake, and maybe a series of days of data from 1 of the lakes.

@lawinslow
Copy link
Member Author

I'd like to load from text files as opposed to RData files. It's slower, but it is much closer to an actual use-case. I dislike it when an example is unrealistic.

@rBatt
Copy link
Contributor

rBatt commented Mar 18, 2014

use the .RData files so that R objects are imported and lazy loaded. Maybe you can do this when reading from text, but I'm not sure. Point is that the package will just load those objects when someone goes to use them, no scripts to actually read in the text.

On the other hand, you have a fair point about RData files – would we let them see how we read .txt in? Seems like this would be hidden anyway. Also, .txt plays nicer w/ GitHub.

@lawinslow
Copy link
Member Author

The lazy loading is only relevant when the data is used within the package. We are just including data as an example and they will never be loaded by the package. Eventually, we will need to pare-down the data we have as our files are too big for CRAN. But I stand by the "real-world use scenario" idea.

@rBatt
Copy link
Contributor

rBatt commented Apr 21, 2015

Has this been completed?

@jordansread
Copy link
Member

This seems to exist in demo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants