proposal: vignette on working with adp objects

dankelley / oce

R package for oceanographic processing

http://dankelley.github.io/oce/

GNU General Public License v3.0

145 stars 42 forks source link

proposal: vignette on working with adp objects #1406

Closed dankelley closed 6 years ago

dankelley commented 6 years ago

Further to my discussion with CR today, I think it would make sense to have a specialized vignette about working with adp data. If others agree, please put a thumbs-up below (and feel free to suggest topics). I'd particularly be interested to hear ideas for topics from @Echisholm21, who is new to this.

A preliminary outline might be

reading adp files
- examples of generic read.oce and more specialized calls to e.g. read.adp.rdi
- discussion of extra arguments such as latitude (and explanation of how they can be added later)
how to read the output from summary
how to plot
subsetting
changing coordinate systems
accessing data within adp objects
- [["v"]] examples: mean currents; anomaly detection; eigenanalysis
- pressure and time, used to find tidal phase

EOGrady21 commented 6 years ago

This sounds great! Let me know if I can be of any help.

dankelley commented 6 years ago

@Echisholm21 maybe when I write it, I'll send it to you first (in Rmd and pdf). That way, you could tell me if things are confusing, or whether some topics are covered too much, others too little.

dankelley commented 6 years ago

I've written up a vignette, and incorporated it into the "develop" branch. It may be accessed with

vignette("adp", package="oce")

I'm closing this issue, because it (as defined by the title) has been addressed. If anyone has comments on edits for the new vignette, I propose they send them to me by email. (With a document this long, it's normally easiest to print it, mark it up, and email a scan of the marked-up copy. Another method would be to print to PDF and then use markup tools, although I find the paper version a lot easier as an editor and author.)

richardsc commented 6 years ago

Thanks. I had a quick read-through, and will likely have some edits. If so, I'll make a pull request.

dankelley commented 6 years ago

Thanks. Feel free to add yourself as an author, if warranted. (Ditto for @Echisholm21)

What I wrote is quite rough, and I may have forgotten some very major things. As with my book, I put some interesting content in exercises, as a way to get readers to try things out.

richardsc commented 6 years ago

I've got some edits I'm going to make in a Pull Request, but when I follow the instructions (commented, at the beginning of the vignette) to build it, the result is that a couple of files currently contained in git are going to be deleted. Does that matter? Or do you have some unnecessary files included where they shouldn't be?

dankelley commented 6 years ago

What matters is whether you edited in vignettes (the right way) or in inst/doc (the wrong way). If you did in vignettes, then all should be ok. To be honest, the vignette processing steps confuse me a lot, and I'm just doing something that Hadley (or someone I respect) said, and that didn't cause problems. As far as I can tell, the build system makes two copies of these files.

richardsc commented 6 years ago

I edited in vignettes/. I'll just push what I have and make a PR. You can deal with it if the files aren't actually supposed to be there.

dankelley commented 6 years ago

Perfect, thanks!

richardsc commented 6 years ago

See PR #1407

richardsc commented 6 years ago

If you're happy with the edits you can go ahead and close this.

dankelley commented 6 years ago

Yup, edits look great, thanks. If @Echisholm21 wants more things to be added, I'd be happy to do so. I want this vignette to be something that an adp newcomer might find useful.