gagolews / TurtleGraphics

Turtle Graphics in R
23 stars 10 forks source link

Package Vignette #14

Closed gagolews closed 10 years ago

gagolews commented 10 years ago

http://cran.r-project.org/doc/manuals/r-devel/R-exts.html#Writing-package-vignettes

cenka commented 10 years ago

I will start preparing pkg vignette.

andromeda14 commented 10 years ago

Maybe I can help you with that? If so, tell me what to do so I don't hinder

cenka commented 10 years ago

I start it, but without move functions there is not much I can do. So I will commit the draft in a while and wait till those functions will be ready. Right now I am working on reset function (the function which will clean the picture area and .turtle_history.

andromeda14 commented 10 years ago

Ok, I'll take a look at it then and add something about turn and set_param (they seem to work with temporary forward function).

MarcinKosinski commented 10 years ago

So far vignettes looks pretty nice.

cenka commented 10 years ago

The draft of vignettes is done. I decided not to produce figures in chuncs - but saved them as .pdf. Feel free to add sth. I will be AFK till early evening.

andromeda14 commented 10 years ago

I am going to run some tests now on moving and turning and then add somethin to vignette.

MarcinKosinski commented 10 years ago

U may get caught on some errors that are produced when turtle is very close to a boarder and is told to move very far away thru that boarder. I know how to fix this little Bug but I'll fix it in hour or two. The problem-causing line is in "poligon function", in coordintaes to draw

MarcinKosinski commented 10 years ago

BTW, nice results of your tests :) mb should you put those figures in Vignettes ? Or I can add them to our website.

andromeda14 commented 10 years ago

As soon as I'm done with documentation for turn and set_param I'll add soem examples to vignettes ;)

andromeda14 commented 10 years ago

Has anyone found some bug anywhere? If so please report it in appropriate issue (to each function), so we can fix it.

MarcinKosinski commented 10 years ago

Can we use your code (spiderwebs etc) from tests in examples in some functions ? It's gr8 ! Is it your invention or mb u found it in the internet ? I'll also add it to our website ;p

andromeda14 commented 10 years ago

Sure, i'm just adding these plots to vignbettes, you can put it on the website too ;)

MarcinKosinski commented 10 years ago

Check folder: worth_seeing

and

andromeda14 commented 10 years ago

Good one! :) If you don't mind I'll write about it in vignettes on 'how to plot Turtle fast aka TutboTurtle' ;)

andromeda14 commented 10 years ago

Ok, I'm not changing vignettes anymore.

MarcinKosinski commented 10 years ago

Should in vignette on 1st figure be: initialization on initiation ?

and also there is missspeling in :

You may also change graphical """paramaeters""" more easily by functions set col(), set lty(), set lwd().

cenka commented 10 years ago

Marcin do you working on vignette rigth now, because I do... Give me info so we avoid conflict, ok?

MarcinKosinski commented 10 years ago

I am not. I am just reading it. So I leave my info here.

MarcinKosinski commented 10 years ago

Section 2. Title:

Let the party start! not "let the party started"

or the best would be : "let the party begin" :)

MarcinKosinski commented 10 years ago

On monday we have problem with downloading our package cose of vignette. On monday's afternoon I've changed vignette and compile it, but I did not rebuilt package. Do you think this could be a reason?

cenka commented 10 years ago

Maybe. When you changed the vignette on monday do you chenged the options in to knitr? If I remember it clearly it has to be changed in some pkg options (default is Sweave - in instructions they allowed to use knitr - I add apropriate comment in vignette but it also has to be changed in pkg options). The errors we get on labs were about Sweave chuncks options (they are a little bit different than knitr otpions). And that could be a reason :)

MarcinKosinski commented 10 years ago

It wa made by knitr package.

cenka commented 10 years ago

Then I do not know what went wrong :) In manual they write that we can use knitr and just to add special comment about it in a file and chenge the pkg options - as we did. However, I think that if we want to improve the TurboTurtle (I'm in ) and send it to CRAN we should skip the vignette and just make it avaliable on website. What do you think?