status GitHub
version License: GPL

Overview :earth_africa:

touristR is a tourist friendly R package providing useful information to help fellow travellers find the best locations to visit worldwide.

Getting Started :runner:

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites :warning:

In case of package loading failure, please make sure that you have the required versions and packages needed, the full list of requirement is available in the DESCRIPTION file.

Note: This package requires R (>= 3.4.0).

Installation :rocket:

#Please install the development version from GitHub:

#forces building the package with the vignette
# remotes::install_github(
#   "AyrtonRua/group1_project",
#   build = TRUE,
#   build_opts = c("--no-resave-data", "--no-manual"),
#   force = T
# )

#alternatively you can use (standard installation approach)

Usage :computer:

Please refer to the documentation of each function run_shiny(), track_twitter_hashtag() and getTopNAttractions(), for further information on how to use each function.

Nonetheless, please find bellow an example from each function:

#run_shiny (interactive Shiny app)
#city = London
#relative_sentiment? (unchecked)

# track_twitter_hashtag(
#   keyword = c("eiffel tower", "san francisco", "london"),
#   type = "place",
#   number = 2,
#   sincetype = "weeks",
#   provideN = 100
#   )

# getTopNAttractions(city = "london",
#                    n = 10)

Screencast :tv:

Screencast package

Getting help :interrobang:

In case of any request including bugs, please open a new issue on the GitHub repository of group 1.

Authors (Group 1 Myama) :santa:

References :books:

Orso, S., Molinari, R., Lee, J., Guerrier, S., & Beckman, M. (2018). An Introduction to Statistical Programming Methods with R. Retrieved from

License :scroll:

This project is licensed under the GPL-2 License - see the LICENSE file for details.

touristR (2018), Group 1 Myama. Released under GPL-2 License.

AyrtonRua/group1_project documentation built on May 14, 2019, 5:14 a.m.