search

GarrettLab / HabitatConnectivity

geohabnet R package
https://garrettlab.github.io/HabitatConnectivity/
GNU General Public License v3.0
7 stars 4 forks source link

documentation #33

Closed krishnakeshav closed 1 year ago

krishnakeshav commented 1 year ago

Adding documentation of functions. Rewriting some to comply with best code code practices.

krishnakeshav commented 1 year ago

documentation is complete. See results below for R cmd check -

── R CMD check results ──────────────────────────────────────────────────────────────────────────────────────── geohabnet 0.0.0.9000 ────
Duration: 1m 33.9s

0 errors ✔ | 0 warnings ✔ | 0 notes ✔

@AaronPlex Kindly review the documentation by installing using following steps -

  1. remove.packages("geohabnet")
  2. restart R session
  3. devtools::install_github(repo = "GarrettLab/CroplandConnectivity", subdir = "geohabnet" , ref = "doc", auth_token = "your github PAT", ref = "fix-package-issue")
  4. library(geohabnet)
  5. geohabnet::SenstivityAnalysis()
AaronPlex commented 1 year ago

I was able to install the package and see documentation following next steps

1. remove.packages("geohabnet") devtools::install_github(repo = "GarrettLab/CroplandConnectivity", subdir = "geohabnet", ref = "doc", auth_token = "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")

2. library(geohabnet) ?geohabnet::senstivity_analysis()

image

Note: there was a duplicated call for ref in install_github() in your code so I used ref = "doc" only

krishnakeshav commented 1 year ago

@AaronPlex , I have modified couple of things including big font. You may want to re-install to continue with your review.