Code Monkey home page Code Monkey logo

fgeo's People

Contributors

benmarwick avatar dchiu911 avatar eddelbuettel avatar forestgeoadm avatar gaborcsardi avatar gregmacfarlane avatar hadley avatar jennybc avatar jimhester avatar kant avatar maurolepore avatar mdlincoln avatar michaeltoth avatar overstreeth avatar riram avatar serhatcevikel avatar zhaoy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

fgeo's Issues

Index datasets

To index datasets -- and even their descriptions -- I can wrap data()

get_datasets <- function(package) {
    dinfo <- data(package = package)
    dinfo[["results"]][, "Item"]
}

get_datasets("ggplot2")

Thanks to Nathan Werth via rstudio community.

React with emoji to learning resources at https://github.com/forestgeo/learn/issues

What is your favorite resource?

The goal of the learn repository is to store learning resources as issues.

Your job is to explore learning resources as issues and react with an emoji. For example, this is how you can up-vote the resources you like:

image

By contributing to this issue you will help others discover the best resources.

If you have any question, please ask me by referring to me as @maurolepore.


Search related issues on https://github.com with: label:hacktoberfest maurolepore

image

Website: Simplify README by adding Get Started

Get Started appears automatically when the package contains an article with the same name of the package.

  • Simplify README to the bare bones. Give detailed installation instructions in blog .
  • Move all the rest of the information to Get Started.
  • Add links to packages.
  • Remove links to packages from References.
  • Leave references only for functions.
  • Add list of all functions to get started.
  • Add list of all datasets to get started.

In README provide a visualization of the structure of fgeo packages

I think this comes from cwickham tidyverse course:

This ...

install.packages("fgeo")

... is equivalent to this

install.packages("fgeo.tool")
install.packages("fgeo.map")
...

And this ...

library(fgeo)

... is equivalent to this

library(fgeo.tool)
library(fgeo.map)
...

Programatically include links to contributors.

Links can be added programatically. This can be useful to add links to packages in README, to funcitons in Get Started; to people's websites on acknowledgements.

For inspiration see:

  • code to generate the list of reviewers here.
  • fgeo README, with links created with fgeo_link() and stored in a knitr::kable().

Improve labels of learning resources at https://github.com/forestgeo/learn/issues

What labels would you add/remove?

The goal of the learn repository is to store learning resources as issues. To make those easy to find I am using labels. The resources and labels accumulated organically, and now it's time to get organized. What labels would you add/remove?

If you have any question, please ask me by referring to me as @maurolepore.


Search related issues on https://github.com with: label:hacktoberfest maurolepore

image

fgeo cleanup

Find what functions are used and not used in each package:

  • May use pkginspector.
  • May use the shell.

Reorganize functions in website:

  • Hide developer-oriented functions with @Keywords internal.
  • Redefine families and use_concept().
  • Label useless functions to be moved to PR.
    • Functions that work with fastField seem too specific to live in fgeo.tool. Extract them into a PR.
    • Functions to read/write from/to files/directories should move to its own package fgeo.io

  • Moved functions from ctfs to fgeo.ctfs (not a core package).
  • Renamed funcitons.
  • Removed functions.
  • Some functions are exported but not shown in website.

Text review

Incorporate text edits from Stuart and Haley.

Update README template.

Use this instead.

use_lifecycle_badge("EDIT-STAGE")
use_travis()

Remove this (.github/ is created automatically with use_tidy_coc()):

use_directory(".github")
# move coc manually to .github/

Remove dependency on ctfs

Downloading GitHub repo forestgeo/ctfs@master
Error in utils::download.file(url, path, method = download_method(), quiet = quiet,  : 
  cannot open URL 'https://api.github.com/repos/forestgeo/ctfs/zipball/master'

Problems is in fgeo.demography()

library(fgeo)
Error in library(fgeo) : there is no package calledfgeo> library(fgeo.map)
> library(fgeo.tool)
> library(soilkrig)
Warning message:
In fun(libname, pkgname) : couldn't connect to display ":0"
> library(fgeo.demography)
Error in library(fgeo.demography) : 
  there is no package called ‘fgeo.demography’
> library(fgeo.abundance)

Rename enline() to anchor() or anchor_regex()

Please briefly describe your problem and what output you expect. If you have a question, please don't use this form. Instead, ask on https://stackoverflow.com/, https://community.rstudio.com/, https://github.com/forestgeo/forum/ or email Mauro Lepore at [email protected].

Please include a minimal reproducible example (AKA a reprex). If you've never heard of a reprex before, start by reading https://www.tidyverse.org/help/#reprex.


Brief description of the problem

# insert reprex here

Ideas for tutorials

Record videos for an overview of fgeo.

  • fgeo home
  • searching functions, packages and datasets
  • understanding helpfiles
  • Write. Finish blog on packages
  • Continue adapting rstudio.cloud/primers

Add search with shift + / (?)

Configure following http://pkgdown.r-lib.org/articles/pkgdown.html?q=search%20shift#docsearch-configuration


On Tue, Jun 26, 2018 at 7:47 AM Sylvain Pace [email protected] wrote:
Hi Mauro,

Congratulations, your search is now ready!
I've successfully configured the underlying crawler and it will now run every 24h.

You're now a few steps away from having it working on your website:

  • Copy the following CSS/JS snippets and add them to your page
<!-- at the end of the HEAD --> 
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" /> 

<!-- at the end of the BODY --> 
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script> 
<script type="text/javascript"> docsearch({ 
 apiKey: 'ec79b1c00aff9cd841703edc746e1a71', 
 indexName: 'fgeo', 
 inputSelector: '### REPLACE ME ####', 
 debug: false // Set debug to true if you want to inspect the dropdown 
}); 
</script> 

Please open a pull request if want to leverage your configuration!

Feel free to get back to us if you have any issues or questions regarding the integration.

We'd also be happy to get your feedback and thoughts about DocSearch - so we can continue to improve it.

Have a nice day :)

Sylvain Pace
Software Engineer
| www.algolia.com | @algolia

Show in readme `apropos()`

> apropos("pick")
character(0)
> library(fgeo)
── Attaching packages ─────────────────────────────────────── fgeo 0.0.0.9000 ──
✔ bciex           0.0.0.9000fgeo.demography 0.0.0.9000fgeo.abundance  0.0.0.9004fgeo.habitat    0.0.0.9006fgeo.base       0.0.0.9001fgeo.map        0.0.0.9204fgeo.data       0.0.0.9002fgeo.tool       0.0.0.9003

Warning message:
In fun(libname, pkgname) : couldn't connect to display ":0"
> apropos("pick")
[1] "pick_dbh_max"   "pick_dbh_min"   "pick_dbh_over"  "pick_dbh_under"
[5] "pick_plotname"  "pick_recensus"  "pick_status"    "pick_top"   

Update standarized documents accross packages.

Standardize infrastructure following this post.


README

Logo:

  • Use logo on the left of package name
<img src="https://i.imgur.com/39pvr4n.png" align="right" height=44 /> 

Badges

EDIT: ADD BADGES CREATED WITH:

use_lifecycle_badge()
use_cran_badge()

EDIT: CONSIDER ADDING BADGES CREATED WITH:

# In .travis.yml consider adding `warnings_are_errors: false`
use_travis()

use_coverage("coveralls")

Installation

# install.packages("remotes")
remotes::install_github("EDIT-OWNER/EDIT-PACKAGE-NAME")

For details on how to install packages from GitHub, see [this article](https://goo.gl/dQKEeg).

Code of Conduct

EDIT: Run this:

use_tidy_coc()

use_directory(".github")
# move coc manually to .github/

Startup message shows fgeo.abundance twice

library(fgeo)
#> -- Attaching packages ------------------------------------------- fgeo 0.0.0.9000 --
#> v fgeo.abundance  0.0.0.9005     v fgeo.demography 0.0.0.9100
#> v fgeo.base       0.0.0.9001     v fgeo.habitat    0.0.0.9006
#> v fgeo.data       0.0.0.9005     v fgeo.map        0.0.0.9204
#> v fgeo.abundance  0.0.0.9005     v fgeo.tool       0.0.0.9003
#> 

Created on 2018-10-19 by the reprex package (v0.2.1)

fgeo_help()

#' if (interactive()) {
#'   fgeo_help("pick")
#' }
fgeo_help <- function(pattern = "", package = fgeo::fgeo_core()) {
  help.search(pattern = pattern, package = fgeo::fgeo_core())
}

Record a 1' video for the Home menu of fgeo

This is the home page of fgeo, an R package that helps you Analyze forest diversity and dynamics.

You may bookmark this page so you can find it quickly.

To find out what you can do with fgeo -- even before you install it -- try a Quick Search for
• packages,
• functios, or
• datasets.
Follow the links for information on any topic.

To install fgeo by running this code.

Then in any R session you can load fgeo with library(fgeo) and find anything run fgeo_help().

You can also narrow down your search with specific keywords, for example fgeo_help ("map").

Each help file has a similar structure -- generally with a title, description, arguments and examples.

With latest versions of RStudio you can run examples directly from the Help tab. Highlight the code you want run and press Control/Cmd enter.

If what you found is not quite what you expected, try the links to related topics.

You can try fgeo on rstudio.cloud for free at http://bit.ly/fgeo-demo

Now go ahead and Get Started

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.