usgs-r / rsurvey Goto Github PK

View Code? Open in Web Editor NEW

13.0 4.0 5.0 14.48 MB

Geographic Information System Application

License: Creative Commons Zero v1.0 Universal

R 99.86% Makefile 0.14%

r spatial gui usgs

rsurvey's Introduction

RSurvey

Deprecated

Development of this package has halted. If you are interested in taking over maintainer status for the package, please email the author.

Overview

The R package RSurvey is a geographic information system (GIS) graphical user interface (GUI) that provides data viewing, management, and analysis tools. The cross-platform application was designed to be simple enough for non-technical users.

Install

If R is not already installed on your computer, download and install the latest binary distribution from the Comprehensive R Archive Network (CRAN). Windows users should set R to operate as a single document interface (SDI) application during installation by choosing to customize the start-up options and specifying the SDI interface (not the default).

If your operating system is macOS, download and install XQuartz, and reboot your computer.

RSurvey uses the Tk toolkit for GUI rendering, access to Tk is provided by the tcltk package. To check if Tk is available, startup an R session and type the following at the command prompt

capabilities("tcltk")

Support for viewing and editing table data is provided by Tktable, a spreadsheet-like Tk widget (typically included with the binary distribution of R). To check if Tktable is available, use the command

inherits(tcltk::tclRequire("Tktable", FALSE), "tclObj")

To install the stable version of RSurvey from CRAN use the command

install.packages("RSurvey")

Or use devtools to install the development version from GitHub.

devtools::install_github("USGS-R/RSurvey")

In addition to its required packages, RSurvey can make use of the functionality in its suggested packages. If any of the suggested packages are missing, you will be prompted to install them when it first starts up.

If you're running into difficulties with package installation, see the R Commander installation notes for possible solutions. R Commander is another GUI implemented as an R package.

Run

Load RSurvey in the current R session and launch its main GUI using the command

library("RSurvey")

Disclaimer

This information is preliminary or provisional and is subject to revision. It is being provided to meet the need for timely best science. The information has not received final approval by the U.S. Geological Survey (USGS) and is provided on the condition that neither the USGS nor the U.S. Government shall be held liable for any damages resulting from the authorized or unauthorized use of the information.

Although this software program has been used by the U.S. Geological Survey (USGS), no warranty, expressed or implied, is made by the USGS or the U.S. Government as to the accuracy and functioning of the program and related program material nor shall the fact of distribution constitute any such warranty, and no responsibility is assumed by the USGS in connection therewith.

rsurvey's People

Contributors

Stargazers

Watchers

Forkers

jfisher-usgs wdwatkins yongalan forked-packages waternk

rsurvey's Issues

Retirement of rgeos, rgdal and maptools

See USGS-R/inlmisc#147; the packages will retire during 2023, action required by year end 2022.

Vignette / blog link

I would suggest prominently displaying putting a link to the github.io page into the README.md. It would be extremely helpful for getting started. (I would actually link to specific blog posts rather than to the page in general).

NOTICE: upcoming default branch name change

The master branch of this repository will soon be renamed from master to main, as part of a coordinated change across the USGS-R and USGS-VIZLAB organizations. This is part of a broader effort across the git community to use more inclusive language. For instance, git, GitHub, and GitLab have all changed or are in the process of changing their default branch name.

We will make this change early in the week of February 6, 2022. The purpose of this issue is to give notification of the change and provide information on how to make it go smoothly.

When this change is made, forks and clones of the repository will need to be updated as well. Here are instructions for making the necessary changes.

On GitHub, change the default branch name from master to main (<your repository> -> Settings -> Branches).
Change the default branch on any forks you have, as well as local clones. (See details below)
If you have collaborators on this repository, let them know that they will need to change their forked/local repos. Point them to this issue to facilitate the process!
Search within your repository for "master" so that you can change references (e.g. URLs pointing to specific commit points of files) to point to "main" instead.
When you are done, feel free to close this issue!

Changing default branches on forks and local clones

First, update your local git configuration so that new repositories created locally will have the correct default branch: git config --global init.defaultBranch main.

Now, for any forks, do the following:

Go to <your fork> -> Settings -> Branches and edit the default branch from master to main.
Update the settings for your local clone of this fork to match this change.

git branch -m master main
git fetch origin
git branch -u origin/main main
git remote set-head origin -a

Typo in github.io (choose_palette)

The function ChoosePalette() should be choose_palette()

Move some (all?) "suggested" packages to "depends"

I would suggest moving the "suggested" packages to "depends", since you need those packages to load the library without issue.

review comments

Looks like you have all the bases covered as far as documenting arguments, general package metadata, etc. My main suggestion would be to add more context to documentation, first and foremost with a vignette (maybe you're already working on this) or two, and also by fleshing out some of the examples. This might be a bit more difficult with GUI functions, but I find examples that are more of a snippet of a workflow, showing in a few lines how you might actually use a key function in practice are more useful than just a one-liner that covers all the arguments. If there are user inputs required, maybe you could just indicate that with comments between lines?

Units tests are another thing that would be nice to have, although I have no idea if/how this is possible for GUI functions. However, there are at least some command-line only functions you could test - I noticed the ProgessBar and Plot3d examples could be run in a test, and a few others. That would be better than nothing. Perhaps there are internal functions you could test as well? Looks like you already have appveyor and travis set up too.

One little functional thing - the example for ManageVariables doesn't run on a clean workspace.