Writers guide

From Comparative Phylogenetics in R
Jump to: navigation, search

Creating New Pages

1) First of all check to see if you need to create a new page: make sure the information you want to add wouldn't fit better in a previously established page. If you need to create a new page, think carefully about the title, it should be clear and concise.

2) Add your new page to the Tutorials table of contents

3) Write the tutorial giving all the information needed for a user with little or no experience in 'R' or with the method you are describing - point people to the appropriate pages about installing packages and basic dataset manipulation. Preferably use a dataset that a user can download from this wiki either by using the geospiza data and the geospiza phylogeny or if these are inappropriate by uploading your own.

4) Break things up into separate tasks with appropriate headings.

5) For other information see Editing Established Pages

Editing Established Pages

1) If the page refers to a specific dataset then please use that dataset when you are writing your descriptions.

2) When writing out code fragments indent the text so that a box appears around it to highlight it.

  My_very_interesting_results<- using.interesting.functions("mydata")

Carefully explain what each part of the code specifies e.g. [,1] specifies column 1 of the dataset.

3) Please note if your description has only been tested on 1 platform (Mac or PC) as we have found some differences in the way some of the methods work on these two platforms.

4) Add the full reference for any publication you mention in the text at the bottom of the page.

Flagging Problems

If you find something that doesn't work and you know why e.g. there was an error in the syntax on the page then please correct the page. If you don't know why it doesn't work please flag it in the text giving the date, platform you are running 'R' on and the version of the software and packages.