No README

[datawookie]

Hi,

Taking a look at your package. It installs fine: well done!

However I've just looked at the repository and noted that there is no README file. This is critical: people need to be able to get an idea of what the package does before they install. Otherwise they won't install.

Look at README on https://github.com/tidyverse/ggplot2 for a good example.

Let me know when this issue has been resolved.

Thanks,
Andrew.

[holt-crews]

We added a README.Rmd file but some of the LaTex formatting is not going through. Any suggestions?

[holt-crews]

And it isn't drawing our charts. Do we need to have it install the package in the R markdown script?

[datawookie]

Your README file should be (plain) markdown not R markdown.

Also not sure if maths is supported in GitHub markdown. See this.

[datawookie]

Any progress with this...?

[holt-crews]

I haven't tried converting to a regular markdown file yet. Is there a way to do this in R studio or can you only do R Markdowns in R studio?

[datawookie]

1. Change the extension from .Rmd to .md.
2. Remove anything that relies on R markdown (as opposed to "plain" markdown).

You can find out more about markdown on GitHub here: https://help.github.com/articles/about-writing-and-formatting-on-github/.