Re: [R] Documenting data

2016-06-30 Thread Ista Zahn
he attributes system in R less useful for documenting data IMO. Best, Ista > > Kind regards > > Georg > >> Gesendet: Donnerstag, 30. Juni 2016 um 20:06 Uhr >> Von: "Bert Gunter" >> An: g.maub...@gmx.de >> Cc: "Pito Salas" , "R Hel

Re: [R] Documenting data

2016-06-30 Thread G . Maubach
"Pito Salas" , "R Help" > Betreff: Re: [R] Documenting data > > I believe Georg's pronouncements are wrong. See inline below. > > -- Bert > > Bert Gunter > > "The trouble with having an open mind is that people keep coming along > a

Re: [R] Documenting data

2016-06-30 Thread Bert Gunter
"] <- "Some explanation about step xy" > > This way you have the documentation in your code and in an external source. > > Which approach you chose depends on your experience with R and its libraries > as well as the size of your project and the need for documentati

Re: [R] Documenting data

2016-06-30 Thread G . Maubach
nting code can be done using roxygen2. If there are different opinions to my suggestions please say so. Kind regards Georg > Gesendet: Donnerstag, 30. Juni 2016 um 16:51 Uhr > Von: "Pito Salas" > An: r-help@r-project.org > Betreff: [R] Documenting data > > I

Re: [R] Documenting data

2016-06-30 Thread Bert Gunter
Private, since this is a trivial comment. Also, just my opinion, so feel free to ignore. Capture it, yes, but not necessarily as a function; just as a script might do, and the tools mentioned can do this. As others have said, your instincts are good, and you should just choose the methods that wor

Re: [R] Documenting data

2016-06-30 Thread Pito Salas
Thanks to you both. I think you’re saying/implying that once I “test drive” a particular bit of cleaning I should capture it in a function which does it reproducibly against the raw data, and that becomes the best documentation for it. That makes sense. Pito Salas Brandeis Computer Science Feld

Re: [R] Documenting data

2016-06-30 Thread Bert Gunter
In addition to what others have suggested, see ?history. Cheers, Bert Bert Gunter "The trouble with having an open mind is that people keep coming along and sticking things into it." -- Opus (aka Berkeley Breathed in his "Bloom County" comic strip ) On Thu, Jun 30, 2016 at 7:51 AM, Pito Salas

Re: [R] Documenting data

2016-06-30 Thread Ulrik Stervbo
Vince Buffalo has covers this nicely in his book "Bioinformatics Data Skills". The original data should stay the original data is immutable and Vince then suggests that you have a text file in your data directory where you explain where the data came from and which scripts you used to create a modi

Re: [R] Documenting data

2016-06-30 Thread Robert Baer
You might look at: http://stackoverflow.com/questions/7979609/automatic-documentation-of-datasets You might also, try the FIle | Compile Notebook from within R-Studio (https://www.rstudio.com/) on your well-documented R-scripts to get a nice reproducible recording/report of data analysis wor

Re: [R] Documenting data

2016-06-30 Thread Christopher W Ryan
Pito-- You describe excellent practices. The R code itself, saved as a script, provides some documentation of how you got from original data to wherever you are. Use # comments liberally. Whenever possible, save your raw data, however it was when you got it--avoid changing it--make all the c

[R] Documenting data

2016-06-30 Thread Pito Salas
I am studying statistics and using R in doing it. I come from software development where we document everything we do. As I “massage” my data, adding columns to a frame, computing on other data, perhaps cleaning, I feel the need to document in detail what the meaning, or background, or calculat