ba23f768f7
## What changes were proposed in this pull request? Changes to DESCRIPTION to build vignettes. Changes the metadata for vignettes to generate the recommended format (which is about <10% of size before). Unfortunately it does not look as nice (before - left, after - right)   Also add information on how to run build/release to CRAN later. ## How was this patch tested? manually, unit tests shivaram We need this for branch-2.1 Author: Felix Cheung <felixcheung_m@hotmail.com> Closes #15790 from felixcheung/rpkgvignettes.
56 lines
1.7 KiB
Bash
Executable file
56 lines
1.7 KiB
Bash
Executable file
#!/bin/bash
|
|
|
|
#
|
|
# Licensed to the Apache Software Foundation (ASF) under one or more
|
|
# contributor license agreements. See the NOTICE file distributed with
|
|
# this work for additional information regarding copyright ownership.
|
|
# The ASF licenses this file to You under the Apache License, Version 2.0
|
|
# (the "License"); you may not use this file except in compliance with
|
|
# the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
|
|
# Script to create API docs and vignettes for SparkR
|
|
# This requires `devtools`, `knitr` and `rmarkdown` to be installed on the machine.
|
|
|
|
# After running this script the html docs can be found in
|
|
# $SPARK_HOME/R/pkg/html
|
|
# The vignettes can be found in
|
|
# $SPARK_HOME/R/pkg/vignettes/sparkr_vignettes.html
|
|
|
|
set -o pipefail
|
|
set -e
|
|
|
|
# Figure out where the script is
|
|
export FWDIR="$(cd "`dirname "$0"`"; pwd)"
|
|
export SPARK_HOME="$(cd "`dirname "$0"`"/..; pwd)"
|
|
|
|
# Required for setting SPARK_SCALA_VERSION
|
|
. "${SPARK_HOME}"/bin/load-spark-env.sh
|
|
|
|
echo "Using Scala $SPARK_SCALA_VERSION"
|
|
|
|
pushd $FWDIR
|
|
|
|
# Install the package (this will also generate the Rd files)
|
|
./install-dev.sh
|
|
|
|
# Now create HTML files
|
|
|
|
# knit_rd puts html in current working directory
|
|
mkdir -p pkg/html
|
|
pushd pkg/html
|
|
|
|
Rscript -e 'libDir <- "../../lib"; library(SparkR, lib.loc=libDir); library(knitr); knit_rd("SparkR", links = tools::findHTMLlinks(paste(libDir, "SparkR", sep="/")))'
|
|
|
|
popd
|
|
|
|
popd
|