fgeo icon indicating copy to clipboard operation
fgeo copied to clipboard

Follow up on fgeo review

Open maurolepore opened this issue 5 years ago • 12 comments

Added detailed installation instructions

The home page of fgeo now shows detailed installation instructions. The additional instructions should reduce installation problems.

fgeo installs if the required R environment is provided (see build history) but most users lack such an environment. Most users have an R environment that can install compliled packages from CRAN but not source packages from GitHub. Notice how much shorter is the path to install packages from CRAN compared to GitHub (via):

image

The bottom line is this: Installation problems would be further reduced if packages lived on CRAN.

Added link to ask questions, requests features and report bugs

At the very top, the home page of fgeo now reads: "Contact me to ask Questions, report bugs, or propose features". While this link was already available, it was cryptic and suggested that it was only for reporting bugs.

Expanded the list of authors

Now the list of authos of fgeo shows the authors of each individual packages including Rick Condit (@laosuz please let me know if Rick should be added somewhere else). I'm no-longer listed as an author of fgeo.ctfs (only as maintainer).

Added instructions to remove fgeo

The installation instructions now explain how to remove a previous installation of fgeo: "You can remove fgeo with remove.packages("fgeo")". While a new installation should overwrite an old one, it is a good idea to help users recover their old R environment (without fgeo).

Added instructions for users to close all other R sessions and restart R

An fgeo package may fail to install if an open R session is using an old version of the package the user wants to install. This problem is eliminated if users close all other R sessions and restart the current session. These instructions are now included in the detailed installation instructions (item 4 and item 10).

Added link to source code in fgeo.ctfs

Now the help file of both the new and old implementation of demography functions point to the source code in the fgeo.ctfs package (here, and here).

Drafted a high-level explanation of what fgeo does

@teixeirak, @seanmcm, and all, Can you please review/edit my draft (#65)?

Welcome contributions to demography help files

@seanmcm, could you help me improve the documentation of fgeo.demography? Here is the source and rendered version in fgeo.demography; and here is the source and rendered version in fgeo.ctfs. You may email me your suggestions or edit the source directly -- which will crate a pull request.

maurolepore avatar Oct 31 '18 12:10 maurolepore